InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/webhooks/stats

How your webhook deliveries went, for every endpoint or one: succeeded and failed per hour or day, your server's answer time (p50 and p95), the failures grouped by error and HTTP status, and counts per event type.

Needs scope webhooks:read.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Query Parameters

account_id?string

A team you belong to, to act on its events; empty for your own account.

endpoint_id?string

One endpoint's id; empty for all of them.

range?string

24h, 7d (the default) or 30d.

Response Body

iohr.events.v1.GetDeliveryStatsResponse

application/json
  1. response

iohr.events.v1.GetDeliveryStatsResponse

bucket*string
buckets*array<>
errors*array<>
failed*string
Formatint64
in_flight*string
Formatint64
p50_ms*integer
Formatint32
p95_ms*integer
Formatint32
range*string
succeeded*string
Formatint64
types*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.events.getDeliveryStats();  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

{  "bucket": "string",  "buckets": [    {      "failed": "string",      "p50_ms": 0,      "p95_ms": 0,      "start": "string",      "succeeded": "string"    }  ],  "errors": [    {      "count": "string",      "error": "string",      "last_at": "string",      "status_code": 0    }  ],  "failed": "string",  "in_flight": "string",  "p50_ms": 0,  "p95_ms": 0,  "range": "string",  "succeeded": "string",  "types": [    {      "failed": "string",      "succeeded": "string",      "type": "string"    }  ]}

Recover an endpoint POST

Sends again what the endpoint missed since a time: every delivery that failed for good, and every event of its types that was never sent to it (while it was turned off), oldest first, 10,000 a call. `truncated` says to call again with the same `since`. Needs scope `webhooks:write`.

List test inboxes GET

The account's test inbox, when it has one: its id, its address and when it expires. Needs scope `webhooks:read`.