Agent inboxes

Claim events

POST/v1/agent/inbox/:id/claim

Leases the events you chose. Events another consumer holds come back in unavailable.

Parameters

Path parameters1

idstringRequired

Destination ID (dst_…).

Body parameters2

event_idsstring[]Required

Events to lease.

ack?string

manual or pickup.

Returns

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

POSTClaim events

curl -X POST "https://api.getensue.com/v1/agent/inbox/dst_…/claim" \
  -H "authorization: Bearer $ENSUE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"event_ids":["evt_…"]}'

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

import os, requests

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

200Response

{
  "events": [],
  "unavailable": []
}

{"events":[],"unavailable":[]}