Skip to content

POST /v3/callbacks/endpoints/{id}/verify

Sends the endpoint a new verification challenge (202, the endpoint): it is unverified, and its deliveries are held, until it answers 2xx with exactly the challenge. An earlier challenge not yet sent is dropped; an answer to it no longer verifies. The challenge goes to the endpoint's stored url; the body is optional and has no members. 409 endpoint_disabled for an inactive endpoint (PATCH active: true verifies it again). /verify and /test share a limit of 6 a minute per organization (burst 3): beyond it 429 rate_limited (reason verify_test, Retry-After). 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
idpathstringyesThe endpoint's id (cbe_ and 24 hex digits).

Request body

A CallbackVerifyRequest object, as JSON.

Responses

StatusBodyDescription
202CallbackEndpoint (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter, or a body that is not one JSON document (code invalid_body).
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).
404Problem (application/problem+json)Not found.
409Problem (application/problem+json)endpoint_disabled: the endpoint is inactive; PATCH active: true verifies it again.
415Problem (application/problem+json)The body is not sent as Content-Type: application/json (code unsupported_media_type).
429Problem (application/problem+json)rate_limited, reason verify_test: the organization's limit of verifications and test sends (the configured rate and burst) is used up, retry after Retry-After; reason test_capacity (/test only): the server runs its most test sends at once, retry after Retry-After.
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 202 carries a CallbackEndpoint object.

FieldTypeRequiredDescription
activebooleanyes
created_atdate-time (RFC 3339, UTC)yes
descriptionstring | nullyes
event_typesarray of stringyes
healthobjectyes
health.consecutive_failuresintegerno
health.disabled_atdate-time (RFC 3339, UTC) | nullno
health.disabled_reasonstring | nullno
health.failing_sincedate-time (RFC 3339, UTC) | nullno
health.last_success_atdate-time (RFC 3339, UTC) | nullno
health.statestringyesOne of: unverified, active, failing, disabled.
health.verified_atdate-time (RFC 3339, UTC) | nullno
idstringyescbe_ and 24 hex digits.
last_24hobjectyesDeliveries of the last 24 hours by state.
last_24h.deliveredintegerno
last_24h.droppedintegerno
last_24h.failedintegerno
last_24h.heldintegerno
updated_atdate-time (RFC 3339, UTC)yes
urlstringyesAs stored: https, the host in lower case, no :443, / for an empty path.

Example request

Shell
curl -sS -X POST -H "Authorization: Bearer $SECBLAST_API_KEY" \
  -H "Content-Type: application/json" -d @body.json \
  'https://api.secblast.com/v3/callbacks/endpoints/cbe_0123456789abcdef01234567/verify'

More in Webhooks (API: callbacks)

Previous: POST /v3/callbacks/endpoints/{id}/test · Next: GET /v3/search/subscriptions

Markdown version: /docs/reference/post-callbacks-endpoints-id-verify.md