Dispatch

Create an endpoint

POST/v1/dispatch/customers/:ref/endpoints

Adds a webhook endpoint for a customer. The response includes the signing secret once.

Parameters

Path parameters1

refstringRequired

The customer's external_id or its cst_ ID.

Body parameters3

urlstringRequired

HTTPS URL that receives events.

event_types?string[]

Event types to deliver. Leave out for all.

description?string

Up to 200 characters.

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/dispatch/customers/acme/endpoints" \ -H "authorization: Bearer $ENSUE_API_KEY" \ -H "content-type: application/json" \ -d '{"url":"https://acme.example.com/hooks","event_types":["order.shipped"]}'

const res = await fetch("https://api.getensue.com/v1/dispatch/customers/acme/endpoints", { method: "POST", headers: { authorization: `Bearer ${process.env.ENSUE_API_KEY}`, "content-type": "application/json", }, body: JSON.stringify({ "url": "https://acme.example.com/hooks", "event_types": [ "order.shipped" ] }), }); console.log(await res.json());

import os, requests res = requests.post( "https://api.getensue.com/v1/dispatch/customers/acme/endpoints", headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}, json={ "url": "https://acme.example.com/hooks", "event_types": [ "order.shipped" ] }, ) print(res.json())

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

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