Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

API token from the Zenedu dashboard

Headers

Signature
string
required

HMAC-SHA256 of the raw request body, hex. The key is the API token of the account

X-Event-Type
string
required

Event type, the same as event in the body

X-Webhook-ID
string
required

Delivery ID, the same as _id in the body

Body

application/json

Body of every webhook delivery

_id
string
required

Unique delivery ID (ULID), the same as the X-Webhook-ID header. Retries of a delivery keep it, use it to skip duplicates

Example:

"01JCQ8Z5W3K7X2M4N6P8R0T2V4"

event
string
required

Event type, the same as the X-Event-Type header

Allowed value: "task.approved"
description
string | null
required

Description of the webhook subscription

timestamp
string<date-time>
required

When the event happened (ISO 8601)

data
object
required

Event object, its shape depends on event

Response

2XX

Return any 2xx status within 3 seconds to confirm the delivery. Any other status, a connection error or a timeout is retried