AXaxilioai
webhooks

Send a test event

Changed on

Publishes a simulated event to the caller's organization so an endpoint can be verified end to end. Name an event_type from the catalog to simulate it with that type's sample payload (default webhook.test), and an endpoint_id to deliver to that endpoint only (a missing or wrong-organization id returns 404; an endpoint not subscribed to the type is a validation error rather than a silent no-op). Omit the body to deliver webhook.test to every endpoint subscribed to it. The event is queued, not delivered synchronously; the response carries the event id to look up in the delivery log.

post/webhooks/deliveries:sendTest

Request

Request body

$schemastring uri

A URL to the JSON Schema for this object.

endpoint_idstring

Deliver the test event to this endpoint only. It must be subscribed to the event type. Omit to deliver to every endpoint subscribed to the type.

event_typestring

The event type to simulate, from the event-type catalog; the event carries that type's sample payload. Omit for webhook.test.

Example request

{
  "$schema": "/api/v1/WebhookTestEventRequest.json"
}

Response

Accepted

$schemastring uri

A URL to the JSON Schema for this object.

endpoint_idstring

The endpoint the test event was aimed at, when one was named in the request.

event_idstring required

Identifier of the published test event.

event_typestring required

Event type of the published test event.

Example response

{
  "$schema": "/api/v1/WebhookTestEventResponse.json"
}

Changes