Skip to content

GET /v3/callbacks/endpoints

The organization's webhook endpoints, newest first, with limits.endpoints (the plan's limit and the active endpoints), each with its health and last 24 hours of deliveries. 403 plan_required for a plan without callbacks. 503 callbacks_unavailable while this server has no callback key file or its database lacks the callback tables.

API key: required. See Authentication.

Group: Webhooks (API: callbacks)

Parameters

NameInTypeRequiredDefaultDescription
limitqueryintegerno50Page size, 1..100 (GET).
cursorquerystringnoOpaque cursor from a previous page's next_cursor (GET).

Responses

StatusBodyDescription
200CallbackEndpointList (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter.
401Problem (application/problem+json)Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728).
403Problem (application/problem+json)The credential's scope does not cover this route (code forbidden), or the organization's plan has no callbacks (code plan_required).
409Problem (application/problem+json)The plan's limit of active endpoints is reached (code limit_reached, with members kind, limit and used); or the endpoint changed while a PATCH was being checked (code conflict: retry).
503Problem (application/problem+json)Callbacks are not available: this server has no callback key file or its database lacks the callback tables (code callbacks_unavailable); too many callback URLs are being checked at once (code db_unavailable, reason resolver_busy, Retry-After 1); or the database is unavailable (code db_unavailable).
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a CallbackEndpointList object.

FieldTypeRequiredDescription
dataarray of CallbackEndpointyes
has_morebooleanyes
limitsobjectyes
limits.endpointsobjectno
limits.endpoints.limitinteger | nullnoThe plan's limit; 0 without callbacks.
limits.endpoints.usedintegernoActive endpoints.
next_cursorstring | nullyes

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/callbacks/endpoints'

Open this route in the console

More in Webhooks (API: callbacks)

Previous: POST /v3/callbacks/deliveries/{id}/retry · Next: POST /v3/callbacks/endpoints

Markdown version: /docs/reference/get-callbacks-endpoints.md