webhook.test

A manual test ping triggered via the test endpoint. We POST a signed WebhookEventEnvelope with topic: "webhook.test" to your registered endpoint.

Header Parameters

Content-Type*"application/json"

Value in

User-Agent?string

X-Webhook-Id*string

The event id (matches the envelope id); stable across retries.

Formatuuid

X-Webhook-Topic*string

X-Webhook-Timestamp*string

Unix seconds; part of the signed string. Reject stale requests.

X-Webhook-Signature*string

HMAC-SHA256 over "<X-Webhook-Timestamp>.<raw request body>" using your signing secret, hex-encoded and prefixed sha256=.

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The JSON body we POST to your endpoint. data shape depends on topic — order/tracking topics carry an OrderEventData.

id*string

Event id — identical across every webhook that receives this event; use it to dedupe retries.

Formatuuid

topic*string

created_at*string

ISO-8601 timestamp of when the event was emitted.

Formatdate-time

data*|

Event payload. An OrderEventData for order/tracking topics.

Example Requests

The JSON body we POST to your endpoint. data shape depends on topic — order/tracking topics carry an OrderEventData.

POST/webhook.test