Subscriptions and waits

Schedule an event

POST/v1/agent/schedules

Puts an event in an inbox at a later time.

Parameters

Body parameters6

inboxstringRequired

The inbox ID (dst_…).

in_seconds?integer

Seconds from now. Pass this or at.

at?string

ISO time, up to 30 days ahead.

payload?object

Delivered as the event body.

label?string

Your own label.

ttl_seconds?integer

How long the event may wait once due.

Returns

201A JSON object describing the result.Errors return error and message; see Errors and limits.

curl -X POST "https://api.getensue.com/v1/agent/schedules" \ -H "authorization: Bearer $ENSUE_API_KEY" \ -H "content-type: application/json" \ -d '{"inbox":"dst_…","in_seconds":3600,"payload":{"check":"invoice"}}'

const res = await fetch("https://api.getensue.com/v1/agent/schedules", { method: "POST", headers: { authorization: `Bearer ${process.env.ENSUE_API_KEY}`, "content-type": "application/json", }, body: JSON.stringify({ "inbox": "dst_…", "in_seconds": 3600, "payload": { "check": "invoice" } }), }); console.log(await res.json());

import os, requests res = requests.post( "https://api.getensue.com/v1/agent/schedules", headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}, json={ "inbox": "dst_…", "in_seconds": 3600, "payload": { "check": "invoice" } }, ) print(res.json())