Skip to main content
POST
Test trigger

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

triggerId
string
required

The ti_ public id of the trigger instance to test.

Body

application/json

Optional free-form payload for the synthetic event. Defaulted when omitted.

POST /v1/triggers/{triggerId}/test - optional free-form payload for the synthetic event.

payload
any | null

The record to sign and deliver, as-is. Defaulted server-side when omitted.

Response

What the destination answered - never a record of anything, since nothing is stored.

The result of one synthetic delivery attempt - never persisted, so there is no id to read this back by. Reflects exactly what the destination answered, including a receiver error (delivered: false with a status code), which is a SUCCESSFUL test of a broken endpoint, not a failed call.

delivered
boolean
required

True only on a 2xx from the destination. A non-2xx is still a 200 from this endpoint.

destination
object
required

The destination the test was sent to.

event_id
string

The synthetic event's id, prefixed te_test_ so it is never mistaken for a captured event.

trigger_id
string

The ti_ id of the trigger instance that was tested.

status_code
integer<int32> | null

The destination's HTTP status code, when a response was received at all.

duration_ms
integer<int32>

How long the attempt took, end to end.

error
string | null

Sanitised failure reason - a status code and body excerpt, or a connection/timeout description.