Dispatch

Send an event

POST/v1/dispatch/events

Sends an event to the endpoints that subscribe to its type. Send an Idempotency-Key header, or idempotency_key in the body, so a retry doesn't send twice.

Parameters

Body parameters5

typestringRequired

An event type that exists in your workspace.

dataobjectRequired

The event payload. Validated against the type's schema.

customer?string

Send only to this customer's endpoints (external_id).

endpoint_id?string

Send only to this endpoint (dst_…).

idempotency_key?string

Up to 200 characters. Reusing a key for a different request returns 409.

Returns

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

curl -X POST "https://api.getensue.com/v1/dispatch/events" \ -H "authorization: Bearer $ENSUE_API_KEY" \ -H "content-type: application/json" \ -d '{"type":"order.shipped","customer":"acme","data":{"order_id":"o_123"}}'

const res = await fetch("https://api.getensue.com/v1/dispatch/events", { method: "POST", headers: { authorization: `Bearer ${process.env.ENSUE_API_KEY}`, "content-type": "application/json", }, body: JSON.stringify({ "type": "order.shipped", "customer": "acme", "data": { "order_id": "o_123" } }), }); console.log(await res.json());

import os, requests res = requests.post( "https://api.getensue.com/v1/dispatch/events", headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}, json={ "type": "order.shipped", "customer": "acme", "data": { "order_id": "o_123" } }, ) print(res.json())