Skip to main content
POST
/
v1
/
webhook_endpoints
/
{id}
/
test
Fire a synthetic test delivery
curl --request POST \
  --url https://api.example.com/v1/webhook_endpoints/{id}/test \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "event_type": "image.completed"
}
'
{
  "object": "webhook_test_fire",
  "endpoint_id": "we_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
  "event_id": "evt_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
  "enqueued": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.aurous-labs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Your team API key (starts with al_live_ — legacy keys may start with og_).

Headers

​
Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-05-15 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-15"

Path Parameters

​
id
string
required

Opaque endpoint id.

Example:

"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"

Body

application/json
​
event_type
enum<string>
required

Event type to fire as a synthetic delivery. Must be one of the v1.0 event types your endpoint subscribes to. The receiver sees a real signed payload with synthetic: true on the envelope.

Available options:
image.completed,
image.failed,
image.cancelled,
video.completed,
video.failed,
video.cancelled,
usage.balance_low,
webhook.endpoint_disabled
Example:

"image.completed"

Response

Delivery enqueued

​
object
string
Example:

"webhook_test_fire"

​
endpoint_id
string
Example:

"we_01HXMQ7Z3K8Y2NABCDEFGHJKMN"

​
event_id
string
Example:

"evt_01HXMQ7Z3K8Y2NABCDEFGHJKMN"

​
enqueued
boolean
Example:

true