Skip to main content
Send a signed ping through the same outbound gate as a delivery and report the outcome (nothing is persisted)
Preview. This operation is not served yet: it is part of the released contract (version 1.0.0). Build against a mock of the contract until the sandbox serves it; see Testing: mock and sandbox.

Autorizzazioni

Authorization
string
header
obbligatorio

A key starts with gbd_live_ (production) or gbd_test_ (sandbox) and ends in a CRC32 checksum of its secret part, so a mistyped or truncated key is refused before any lookup, as is a key of the other environment. The prefix is registered with public secret scanners (GitHub secret scanning, TruffleHog, GitGuardian): a key found in a public repository is revoked at once and your technical contact is told. Gridbeds stores only a hash of each key. One partner may hold two keys per environment during a rotation. Operations list the scopes they need; the scopes are OAuth 2.0 scope tokens, so short-lived access tokens from a client-credentials grant can be offered later beside keys, with the same scopes and no change to any operation.

Parametri del percorso

webhook_id
string
obbligatorio
Pattern: ^whk_[0-7][0-9a-hjkmnp-tv-z]{25}$
Esempio:

"whk_3fksgepbgj9yqv8wccdx8sxs8v"

Risposta

The ping's outcome.

event_id
string
obbligatorio

Never a cursor.

Pattern: ^evt_(test_)?ping_[0-9a-hjkmnp-tv-z]{26}$
delivered
boolean
obbligatorio
response_status
integer | null
obbligatorio

null when no response arrived; a 3xx is not followed and counts as not delivered.

error
enum<string> | null
obbligatorio

Open enum.

Opzioni disponibili:
timeout,
dns_failure,
connection_refused,
tls_error,
connection_failed,
blocked_unsafe_target,
http_error,
outbound_channel_closed,
partner_not_entitled,
endpoint_suspended,
endpoint_failing