Skip to main content
Register an endpoint (at most 5) and receive its signing secret once
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.

Corpo

application/json
url
string<uri>
obbligatorio

A public HTTPS address on port 443. A private, reserved, loopback or link-local target is refused with errors[].code url_not_allowed; redirects are never followed.

Maximum string length: 2048
Pattern: ^https://
events
string[]
obbligatorio

Each must be covered by your key's scopes.

Required array length: 1 - 20 elements
Pattern: ^(\*|[a-z]+\.\*|[a-z]+\.[a-z_]+)$
description
string | null
Maximum string length: 255

Risposta

Created. Store the secret now; it is never shown again.

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

"whk_3fksgepbgj9yqv8wccdx8sxs8v"

url
string<uri>
obbligatorio
events
string[]
obbligatorio
Pattern: ^(\*|[a-z]+\.\*|[a-z]+\.[a-z_]+)$
status
enum<string>
obbligatorio

inactive: suspended (see suspended_reason); nothing is delivered until it is enabled again.

Opzioni disponibili:
active,
inactive
health
object
obbligatorio
version
integer<int64>
obbligatorio

Grows on every change visible to this channel; ignore a lower one. Not a counter — do not expect consecutive values.

Intervallo richiesto: x >= 1
created_at
string<date-time>
obbligatorio
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Esempio:

"2026-10-16T09:30:00Z"

updated_at
string<date-time>
obbligatorio
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Esempio:

"2026-10-16T09:30:00Z"

secret
string
obbligatorio

Standard Webhooks secret (32 random bytes); shown once.

Pattern: ^whsec_[A-Za-z0-9+/]+={0,2}$
description
string | null
suspended_at
string<date-time> | null
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Esempio:

"2026-10-16T09:30:00Z"

suspended_reason
enum<string> | null
Opzioni disponibili:
failing,
gone,
null
previous_secret_expires_at
string<date-time> | null
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Esempio:

"2026-10-16T09:30:00Z"