Skip to main content
id
string
required
dateCreated
string<date-time>
required
dateUpdated
string<date-time>
required
name
string
required
endpoint
string
required
sdkConnections
string[]
required
httpMethod
enum<string>
required
Available options:
GET,
PUT,
POST,
DELETE,
PURGE,
PATCH
payloadFormat
enum<string>
required
Available options:
standard,
standard-no-payload,
sdkPayload,
edgeConfig,
edgeConfigUnescaped,
vercelNativeIntegration,
none
lastSuccess
string<date-time> | null
required
error
string
required
consecutiveFailures
number
required
disabled
boolean
required

Set after repeated failures; changing the endpoint clears it

timeoutSeconds
integer | null
required

Request timeout in seconds, up to the server maximum (120 unless configured). Null uses the default.

Required range: x >= 1
payloadKey
string
headers
string

JSON-encoded object of extra headers. Only returned by GET, to callers who can edit the webhook.

signingKey
string

Used to verify the signature header. Only returned by GET, to callers who can edit the webhook.