Skip to main content
PATCH
Update destination

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

name
string
required

The destination's name.

Body

application/json

The fields to change. Absent fields are left alone.

PATCH /v1/triggers/destinations/{name} - every field optional, absent means "leave alone".

url
string | null

Re-point the endpoint. Re-validated by the SSRF guard; the signing secret is unchanged.

is_default
boolean | null

Promote to the account default. false is REJECTED rather than demoting: an account must always have exactly one default, and demoting without naming a replacement would leave none. Promote the intended replacement instead.

status
enum<string> | null

Set to active to re-enable an auto-disabled endpoint. This also resets consecutive_failures to zero - without that the counter would still be at its maximum and the very next failure would re-disable the destination, which reads as "re-enabling does not work". auto_disabled is not settable by hand.

Available options:
active,
auto_disabled
max_consecutive_failures
integer<int32> | null

Response

The updated destination.

A named HTTP endpoint Engini delivers trigger events to. The signing secret is never included here - it is shown once, when the destination is created or its secret is rotated.

id
integer<int32>
required

The numeric id, which is what POST /v1/triggers's destination_id takes. Routes address destinations by Name; this is here so a caller can bind a trigger to one without a second lookup.

name
string
required

Slug, unique per account among live destinations.

url
string
required
status
enum<string>
required

Whether a destination is currently accepting deliveries. Engini disables one automatically after too many consecutive failures; updating the destination enables it again.

Available options:
active,
auto_disabled
is_default
boolean

True on the one destination that receives events from triggers naming no destination.

consecutive_failures
integer<int32>

Consecutive DEAD-LETTERED events, not failed attempts. Reset to zero by any successful delivery and by re-enabling the destination.

max_consecutive_failures
integer<int32>

How many consecutive dead-letters auto-disable this endpoint.

last_delivery_at
string<date-time> | null
last_failure_at
string<date-time> | null
last_failure
string | null

Why the last delivery failed, sanitised for a tenant to read - a status code and reason, never a stack trace or an internal host.

created_at
string<date-time>
updated_at
string<date-time> | null