API reference

API reference · Webhooks

The account's webhook delivery log

GET/api/webhooks/deliveriesSigned in session

The newest deliveries to the account's webhooks, each with every attempt: status, time, latency and the first bytes of the answer. Kept for ANTIMATTER_WEBHOOK_LOG_RETENTION_DAYS (30 unless set), and gone with the endpoint that received them.

Parameters

Path and query parameters
FieldTypeWhat it is
event (query)stringOne of "budget.threshold", "key.created", "key.revoked", "price.change", "alert.triggered", "alert.resolved", "credits.low_balance", "plan.renewed", "plan.ended", "model.degraded", "model.recovered", "shadow.candidate_ready", "shadow.auto_switched", "shadow.savings_report", "distill.completed", "distill.proof_ready", "studio.shot_finished", "project.budget_threshold", "spend.forecast_over_cap".
hook (query)integer

Answer 200

The log, newest first.

Fields of the 200 answer
FieldTypeWhat it is
deliveriesrequiredarray of object
deliveries[].idstringdlv_ and 24 hex digits.
deliveries[].hookIdinteger
deliveries[].eventstringOne of "budget.threshold", "key.created", "key.revoked", "price.change", "alert.triggered", "alert.resolved", "credits.low_balance", "plan.renewed", "plan.ended", "model.degraded", "model.recovered", "shadow.candidate_ready", "shadow.auto_switched", "shadow.savings_report", "distill.completed", "distill.proof_ready", "studio.shot_finished", "project.budget_threshold", "spend.forecast_over_cap".
deliveries[].okbooleanThe newest attempt decides.
deliveries[].atinteger
deliveries[].attemptsarray of object
deliveries[].attempts[].attemptinteger1 for the first try; the sender retries a failed delivery on a backoff.
deliveries[].attempts[].statusintegerThe endpoint's HTTP status, or 0 when nothing answered.
deliveries[].attempts[].okboolean
deliveries[].attempts[].latencyMsinteger or null
deliveries[].attempts[].responseHeadstring or nullThe first bytes of the answer, as text with control characters taken out.
deliveries[].attempts[].reasonstring or nullWhy the attempt failed, when it did.
deliveries[].attempts[].atintegerUnix milliseconds.
deliveries[].retryOfstring or nullThe delivery this one sent again.
deliveries[].retriedBystring or nullA later delivery that sent this one again.
deliveries[].retryablebooleanThe payload was kept, so it can be sent again.
retentionDaysinteger

Errors

  • 401OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter