Destinations

Create a destination

POST/v1/destinations

Creates a URL destination. Pass type: "inbox" to create an agent inbox instead (see Create an inbox).

Parameters

Body parameters12

namestringRequired

2–41 lowercase letters, numbers or dashes. Must be unique.

urlstringRequired

HTTPS URL that receives deliveries. Ensue refuses URLs that would loop back into itself.

type?string

inbox creates an inbox. Leave out for a URL destination.

auth_type?string

How Ensue authenticates to your URL (none, bearer, basic, apikey), with token, username and password, or header and value.

timeout_ms?integer

Per-attempt timeout, 1000 to 30000. Default 15000.

max_attempts?integer

Deliveries before the event fails.

retry?object

The retry schedule.

format?string

agent delivers the agent envelope instead of the raw body.

view_bytes?integer

For format: agent: cap on the view, 1 KB to 64 KB. Default 8 KB.

max_in_flight?integer

Most deliveries running at once.

rate_per_second?number

Most deliveries started per second.

groups?object

Delivery group rules, for per-tenant rates. Not for inboxes.

Returns

201The sample response is on the right.Errors return error and message; see Errors and limits.

curl -X POST "https://api.getensue.com/v1/destinations" \ -H "authorization: Bearer $ENSUE_API_KEY" \ -H "content-type: application/json" \ -d '{"name":"billing-api","url":"https://api.example.com/webhooks/ensue"}'

const res = await fetch("https://api.getensue.com/v1/destinations", { method: "POST", headers: { authorization: `Bearer ${process.env.ENSUE_API_KEY}`, "content-type": "application/json", }, body: JSON.stringify({ "name": "billing-api", "url": "https://api.example.com/webhooks/ensue" }), }); console.log(await res.json());

import os, requests res = requests.post( "https://api.getensue.com/v1/destinations", headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}, json={ "name": "billing-api", "url": "https://api.example.com/webhooks/ensue" }, ) print(res.json())

{ "id": "dst_3m9x…", "name": "billing-api", "type": "http", "url": "https://api.example.com/webhooks/ensue", "status": "active", "created": 1762761600000, "auth_type": "none", "signing_secret": "whsec_…", "timeout_ms": 15000, "max_attempts": 8, "format": "raw", "max_in_flight": 10, "breaker": { "state": "closed" } }

{"id":"dst_3m9x…","name":"billing-api","type":"http","url":"https://api.example.com/webhooks/ensue","status":"active","created":1762761600000,"auth_type":"none","signing_secret":"whsec_…","timeout_ms":15000,"max_attempts":8,"format":"raw","max_in_flight":10,"breaker":{"state":"closed"}}