WatificationDocs
Webhooks

ping

Dashboard Send test event. This signed event attempts once, even for disabled endpoints, and failure does not count toward auto-disable. No occurredAt or customer message is included.

Delivered as POST to your configured HTTPS endpoint with Content-Type: application/json. Examples are fictional; the zero digest illustrates syntax only. Verify the signature before parsing. Acknowledge with a small 2xx response within the 10-second overall timeout. Duplicates and out-of-order deliveries are possible; save the event id to avoid processing the same event twice.

Responses

StatusMeaning and codes
2XXYour receiver accepted and saved the event. Any completed 2xx response succeeds; return a small body promptly.
defaultNon-2xx, redirects, timeouts and connection failures fail delivery. Outcome events are retried; ping is not.

Your receiver chooses the response body. The API-key Problem Details contract does not apply to your receiver.

Headers and payload

Header Parameters

User-Agent*string

Webhook sender identity.

Watification-Event-Id*string

Same UUID as envelope id. Use this event ID to avoid processing duplicates; it stays the same on retry and replay.

Formatuuid
Watification-Signature*string

t=<unix seconds>,v1=<lowercase hex HMAC-SHA256>. Sign timestamp + dot + unaltered raw JSON body bytes using the entire whsec_ secret string. Each attempt gets a fresh timestamp. Verify with a constant-time comparison; see webhook verification and recovery.

Match^t=[0-9]+,v1=[0-9a-f]{64}$
Content-Length*string

Request body length in UTF-8 bytes.

Match^[0-9]+$
Watification-Event-Type*string

Same event type as envelope type.

Request Body

application/json
  1. body
id*string

Event UUID; stable across retries and replay.

Formatuuid
type*string

Event type.

createdAt*string

Envelope creation time, distinct from outcome occurredAt.

Formatdate-time
data*

Response Body

Your receiver accepted and saved the event. Any completed 2xx response succeeds; return a small body promptly.