Endpoint referenceWebhook Ingress
Accept one bounded, signed and ordered partner event.
The guarded route is absent unless generic inbound webhooks and its HTTP boundary are enabled.
Path Parameters
tenant*string
Opaque external tenant reference bound into endpoint authority.
Format
uuidendpoint*string
Opaque webhook endpoint reference.
Format
uuidHeader Parameters
X-Webhook-Key-Id*string
Endpoint key generation identifier.
Match
^[a-z0-9][a-z0-9._:-]*$Length
1 <= length <= 120X-Webhook-Timestamp*string
Signed event timestamp within the accepted skew window.
Format
date-timeX-Webhook-Nonce*string
Unique signed request nonce.
Format
uuidX-Webhook-Sequence*integer
Strictly increasing endpoint sequence number.
Range
1 <= valueX-Webhook-Event*string
Stable partner event reference used for exact replay.
Match
^[a-z0-9][a-z0-9._:-]*$Length
1 <= length <= 160X-Webhook-Schema*string
Endpoint-bound payload schema version.
Match
^[a-z0-9][a-z0-9._:-]*$Length
1 <= length <= 80X-Webhook-Signature*string
Lowercase hexadecimal HMAC-SHA256 over the canonical signed envelope.
Match
^[a-f0-9]{64}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Properties
1 <= properties <= 256Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Was this page helpful?