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. Authorization: organization administrators only. Returns 404 if the channel is missing.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channelIdstringRequired

Request

This endpoint expects an object.

namestringRequired1-120 characters

targetobjectRequired

payloadMappingmap from strings to strings or nullOptional

runIfany or nullOptional

Response

The created route.

routeobject

$	curl -X POST https://api.cloudraker.com/channels/channelId/routes \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Incident Response Route",
>	"target": {
>	"kind": "playbook",
>	"playbookId": "pb-9f8e7d6c5b4a3",
>	"spaceId": "space-12345"
>	}
>	}'

1	{
2	"route": {
3	"_id": "route-abc123def456",
4	"channelId": "channel-789xyz",
5	"name": "Incident Response Route",
6	"target": {
7	"kind": "playbook",
8	"playbookId": "pb-9f8e7d6c5b4a3",
9	"spaceId": "space-12345"
10	},
11	"payloadMapping": {},
12	"status": "active",
13	"createdAt": "2024-06-01T10:15:30Z",
14	"archivedAt": "null"
15	}
16	}