Skip to main content
POST
This endpoint accepts a project API key (AS_ prefix). It queues a test delivery of the supplied event to the webhook’s URL. The webhook must already be subscribed to that event.

Authorizations

string | header
required
Project API key header of the form Bearer AS_<key>.

Path Parameters

string
required
The unique identifier of the webhook.Example: "60d5ec49f1b2c72d9c8b1234"

Body

string
required
The event type to deliver. Must be one the webhook is subscribed to.Example: "email.delivered"
object
required
The event payload that will be wrapped and POSTed to the webhook URL.Example: { "messageId": "msg_abc123", "to": "[email protected]" }

Response

Webhook queued for delivery (200)
boolean
Indicates if the request was successful
object
Wrapper containing the queued job reference

Error Responses

object
Returned when the webhook is not subscribed to the supplied event.
object
Returned when no webhook with the given ID exists in the project.