API Documentation
Hooks
Channels
Create
POST
/
rest
/
channels
Copy
curl --request POST \
--url https://copilotz.com/rest/channels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Send Template Message to WhatsApp User",
"description": "Description of this channel.",
"extId": "249688884896294",
"hook": "rpc",
"callback": "whatsapp",
"handlerUrl": "native:agents/taskManager",
"config": {
"copilotzId": 1,
"streamResponseBy": "turn",
"additionalProperties": "additionalPropertyValue"
}
}'
Copy
{
"name": "Send Template Message to WhatsApp User",
"description": "Send Template Message to WhatsApp User",
"extId": "249688884896294",
"hook": "rpc",
"callback": "whatsapp",
"handlerUrl": "native:agents/taskManager",
"config": {
"copilotzId": 1,
"streamResponseBy": "turn",
"additionalProperties": "additionalPropertyValue"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Request payload for creating or updating a channel.
Response
200 - application/json
Successful response
Response containing channel details.
Copy
curl --request POST \
--url https://copilotz.com/rest/channels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Send Template Message to WhatsApp User",
"description": "Description of this channel.",
"extId": "249688884896294",
"hook": "rpc",
"callback": "whatsapp",
"handlerUrl": "native:agents/taskManager",
"config": {
"copilotzId": 1,
"streamResponseBy": "turn",
"additionalProperties": "additionalPropertyValue"
}
}'
Copy
{
"name": "Send Template Message to WhatsApp User",
"description": "Send Template Message to WhatsApp User",
"extId": "249688884896294",
"hook": "rpc",
"callback": "whatsapp",
"handlerUrl": "native:agents/taskManager",
"config": {
"copilotzId": 1,
"streamResponseBy": "turn",
"additionalProperties": "additionalPropertyValue"
}
}
Assistant
Responses are generated using AI and may contain mistakes.