Skip to main content
WEBHOOK

Body

application/json

Sent once each time a subscription is tested. It is never stored or retried, and never appears in the delivery log; acknowledge it like any event.

id
string
required

A fresh id per test, also sent as X-Enrik-Event-Id. Never redelivered.

type
string
required

Always webhook.ping, also sent as X-Enrik-Event-Type.

Allowed value: "webhook.ping"
version
number
required

The payload version.

occurredAt
string<date-time>
required

When the test was sent, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
workspaceId
string
required

The workspace the subscription belongs to.

data
object
required

The subscription that was tested.

Response

200

Answer any 2xx within 10 seconds to acknowledge the event. Anything else, a timeout or a redirect is a failed attempt.