Create a channel route

POST

/channels/:channelId/routes

Adds a route to the channel, binding deliveries to a playbook target with optional payload mapping and a RUN-IF gate. Requires trigger:manage.

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

channelIdstringRequired

This endpoint expects an object.

namestringRequired1-120 characters

targetobjectRequired

payloadMappingmap from strings to strings or nullOptional

The created route.

routeobject

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	curl -X POST https:/https://api/channels/channelId/routes \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Incident Response Route",
6	"target": {
7	"kind": "playbook",
8	"playbookId": "pbk_9f8e7d6c5b4a3",
9	"projectId": "proj_123abc456def"
10	}
11	}'

1	{
2	"route": {
3	"_id": "route_5a1b2c3d4e5f6g7h8i9j",
4	"channelId": "chan_987zyx654wvu321",
5	"name": "Incident Response Route",
6	"target": {
7	"kind": "playbook",
8	"playbookId": "pbk_9f8e7d6c5b4a3",
9	"projectId": "proj_123abc456def"
10	},
11	"payloadMapping": {},
12	"status": "active",
13	"createdAt": "2024-06-01T10:15:30Z",
14	"archivedAt": ""
15	}
16	}