Skip to navigation

Publish a webhook event

Admin tokens only: deliveries carry the platform signature. Queues one signed delivery per ACTIVE subscription of the event type. data must match the event type’s payload schema. Posting the same event_id again queues nothing new.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
eventenumRequired
dataobjectRequired
occurred_atdatetime or nullOptional
event_idstring or nullOptional1-255 characters

Response

How many deliveries were queued.
queuedinteger

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error