Subscriptions and waits

Create a wait

POST/v1/waits

Waits for one correlated event, up to a deadline. If it doesn't arrive, the inbox gets an ensue.wait.missed notice unless on_timeout is none.

Parameters

Body parameters9

sourcestringRequired

Source ID or name.

inboxstringRequired

Inbox ID or name.

correlationstringRequired

The value the event carries at the source's correlate path.

within?integer

Seconds to wait. Pass this or until.

until?string

ISO time to wait until.

match?object

Extra conditions.

on_timeout?string

missed (default) or none.

deliver_after?string

Hold matching events until then.

label?string

Your own task ID.

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/waits" \ -H "authorization: Bearer $ENSUE_API_KEY" \ -H "content-type: application/json" \ -d '{"source":"stripe-prod","inbox":"billing-agent","correlation":"t_42","within":86400}'

const res = await fetch("https://api.getensue.com/v1/waits", { method: "POST", headers: { authorization: `Bearer ${process.env.ENSUE_API_KEY}`, "content-type": "application/json", }, body: JSON.stringify({ "source": "stripe-prod", "inbox": "billing-agent", "correlation": "t_42", "within": 86400 }), }); console.log(await res.json());

import os, requests res = requests.post( "https://api.getensue.com/v1/waits", headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}, json={ "source": "stripe-prod", "inbox": "billing-agent", "correlation": "t_42", "within": 86400 }, ) print(res.json())

{ "id": "sub_9c4t…", "status": "active", "label": "t_42", "source": { "id": "src_8f2k…", "name": "stripe-prod" }, "destination": { "id": "dst_7q1c…", "name": "billing-agent", "type": "inbox" }, "correlation": "t_42", "max_events": 1, "matched": 0, "expires_at": "2026-11-11T10:00:00.000Z", "kind": "wait", "outcome": null, "on_timeout": "missed" }

{"id":"sub_9c4t…","status":"active","label":"t_42","source":{"id":"src_8f2k…","name":"stripe-prod"},"destination":{"id":"dst_7q1c…","name":"billing-agent","type":"inbox"},"correlation":"t_42","max_events":1,"matched":0,"expires_at":"2026-11-11T10:00:00.000Z","kind":"wait","outcome":null,"on_timeout":"missed"}