Is your checkout working right now? Find out in a few minutes, free, no sign-up.Scan my store

Developers

API reference

Read-only access to your stores, incidents, reports and orders, on the Business and Agency plans. Up to 120 requests a minute per key.

Authentication

Create a key in Settings > API keys (account owners). It is shown once; we keep only a fingerprint. Send it with every request:

curl -H "Authorization: Bearer socapi_..." https://app.storeoncall.com/api/v1/stores

Responses are JSON with a data field. Errors have an error field with a plain message: 401 for a missing or revoked key, 404 when a store or incident is not in your account, 429 above the rate limit. Keys keep working when an account requires single sign-on, and stop when revoked. An office IP allow-list, if set, applies to keys too.

Machine-readable description: openapi.json (OpenAPI 3.1), for Postman, Insomnia or code generators.

Webhooks

Alert webhooks are signed: each call has an x-storeoncall-signature: sha256=... header, the HMAC-SHA256 of the raw body with your webhook secret. Compare it before trusting the call. PagerDuty and Microsoft Teams have their own alert channels, so no webhook code is needed for them.

Endpoints

GET /api/v1/stores

List stores. Every store in the account, with its status, last plugin report and last checkout test.

GET /api/v1/stores/{id}

Get a store. One store, including any planned-work window in force.

GET /api/v1/incidents

List incidents. Incidents in a date range (default: the last 30 days), newest first.

Query parameterMeaning
status One of: open, resolved, unacknowledged.
storeStore id
severity One of: critical, high, medium, low.
from
to
limit Default 100.

GET /api/v1/incidents/{id}

Get an incident. One incident with its full timeline: detection, alerts, acknowledgement, notes and resolution.

GET /api/v1/stores/{id}/report

Reliability report. Problems, checkout tests, monitoring coverage, orders and changes for a calendar month, or the last 30 days.

Query parameterMeaning
monthFor example 2026-11

GET /api/v1/stores/{id}/orders

Hourly orders against normal. Orders per hour and the normal level for each hour.

Query parameterMeaning
hours Default 48.
WhatsApp us