Skip to main content
POST
Create destination

Authorizations

Authorization
string
header
required

Enter your JWT token

Body

application/json

The destination's name, url and optional settings.

POST /v1/triggers/destinations.

name
string | null

Slug matching ^[a-z0-9_-]{1,100}$. Reusing the name of a DELETED destination is allowed.

url
string | null

An https URL on a publicly routable host. Re-validated before every delivery.

is_default
boolean | null

Promote this destination to the account default, demoting the incumbent in the same transaction. Omitted or false leaves the current default alone - except on the account's FIRST destination, which becomes the default whatever this says (an account whose only destination is not the default would silently deliver nothing for every trigger created without one).

max_consecutive_failures
integer<int32> | null

Defaults to 5. Must be at least 1.

Response

The created destination, together with its one-time signing secret.

The response to the three calls that MINT a secret: create, rotate-secret, and PUT /v1/triggers/destination when that call creates the account default.

destination
object
required

The destination itself - identical to what every read path returns.

signing_secret
string

The plaintext esec_… HMAC-SHA256 signing secret. Store it now; it is never shown again.