Dispatch

List a customer's endpoints

GET/v1/dispatch/customers/:ref/endpoints

Returns the customer's webhook endpoints.

Parameters

Path parameters1

refstringRequired

The customer's external_id or its cst_ ID.

Returns

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

GETList a customer's endpoints

curl "https://api.getensue.com/v1/dispatch/customers/acme/endpoints" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const res = await fetch("https://api.getensue.com/v1/dispatch/customers/acme/endpoints", {
  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/dispatch/customers/acme/endpoints",
    headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"},
)
print(res.json())

200Response

{
  "items": [
    {
      "id": "dst_6r2n…",
      "customer_id": "cst_4h6w…",
      "customer": "acme",
      "url": "https://acme.example.com/hooks",
      "description": "",
      "status": "active",
      "event_types": [
        "order.shipped"
      ],
      "created": 1762761600000
    }
  ]
}

{"items":[{"id":"dst_6r2n…","customer_id":"cst_4h6w…","customer":"acme","url":"https://acme.example.com/hooks","description":"","status":"active","event_types":["order.shipped"],"created":1762761600000}]}