Agent inboxes

Pull events

GET/v1/agent/inbox/:id/next

Leases up to 10 events and long-polls up to 30 seconds. With ack=manual, close each lease with Ack, Release or Extend.

Parameters

Path parameters1

idstringRequired

Destination ID (dst_…).

Query parameters8

order?string

fifo, lifo or priority.

ack?string

manual or pickup.

max?integer

1 to 10.

wait?integer

Seconds to wait for an event, up to 30.

type?string

Only this event type.

source?string

Only this source.

subscription?string

Only this subscription.

correlation?string

Only this correlation value.

Returns

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

GETPull events

curl "https://api.getensue.com/v1/agent/inbox/dst_…/next" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const res = await fetch("https://api.getensue.com/v1/agent/inbox/dst_…/next", {
  method: "GET",
  headers: {
    authorization: `Bearer ${process.env.ENSUE_API_KEY}`,
  },
});
console.log(await res.json());

import os, requests

res = requests.get(
    "https://api.getensue.com/v1/agent/inbox/dst_…/next",
    headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"},
)
print(res.json())

200Response

{
  "events": [
    {
      "id": "evt_…",
      "lease_id": "lse_…",
      "delivery": 1,
      "ack": "manual",
      "type": "payment_intent.succeeded",
      "verified": true,
      "view": {
        "amount": 4900
      }
    }
  ]
}

{"events":[{"id":"evt_…","lease_id":"lse_…","delivery":1,"ack":"manual","type":"payment_intent.succeeded","verified":true,"view":{"amount":4900}}]}