Create a channel

POST

/channels

Creates an email, webhook, or file_drop channel. Webhook channels are provisioned via Hookdeck when configured, otherwise with a direct-ingest secret. Requires trigger:manage.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

slugstringRequiredformat: "^[a-z0-9][a-z0-9-]*$"1-64 characters

namestringRequired1-120 characters

typeenumRequired

Allowed values:

folderIdstringOptional>=1 character

Response

The created channel.

channelobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	curl -X POST https:/https://api/channels \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"slug": "support-email",
6	"name": "Support Email Channel",
7	"type": "email"
8	}'

1	{
2	"channel": {
3	"_id": "63f1a2b4e4b0c123456789ab",
4	"slug": "support-email",
5	"name": "Support Email Channel",
6	"type": "email",
7	"address": "support@raker.one",
8	"webhookSecret": "null",
9	"hookdeckSourceId": "null",
10	"hookdeckConnectionId": "null",
11	"status": "active",
12	"createdAt": "2024-06-01T09:15:00Z",
13	"archivedAt": "null",
14	"createdBy": "user_987654321",
15	"folderId": "inbox-folder-01"
16	}
17	}