Skip to main content
WEBHOOK

Headers

Webhook-Id
string<uuid>
required

The stable request identifier, equal to the UUID in the request body id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Webhook-Timestamp
integer
required

Unix seconds for this request and the timestamp used in the signature input.

Required range: x <= 9007199254740991
Webhook-Signature
string
required

One or more space-separated v1,BASE64_HMAC values. Each HMAC-SHA256 signs Webhook-Id.Webhook-Timestamp.rawRequestBody with the base64-decoded whsec_ key.

Pattern: ^(?:v1,[A-Za-z0-9+/]{43}=)(?: v1,[A-Za-z0-9+/]{43}=)*$

Body

application/json
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
type
string
required
Allowed value: "endpoint.verification"
data
object
required
createdAt
string
required

Response

Signing-secret possession proved

response
string
required

Base64 HMAC-SHA256 of sparkles.webhook.verify. using the base64-decoded whsec_ key.

Pattern: ^[A-Za-z0-9+/]{43}=$