Skip to main content
POST
/
api
/
v1
/
conversations
/
{id}
/
subscribe
/
cURL
curl --request POST \
  --url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact": {
    "phoneNumber": "<string>",
    "name": "<string>"
  },
  "activeAgent": "<string>",
  "whatsappNumber": "<string>",
  "chatWindowRemainingTime": "<string>",
  "lastMessage": "<string>",
  "isHumanTakeover": "<string>",
  "active": "<string>",
  "routing": "<string>",
  "webhookId": "<string>",
  "routingOverride": "<string>"
}
Switches the conversation to webhook routing and sets the per-conversation webhook override. Fires subscription.activated on the newly assigned webhook unless it was already the active subscriber. While the override is in place, every inbound user message produces a subscription.message.received event sent to the assigned webhook only — the agent pipeline is not run. Clear the override with POST /conversations/{id}/unsubscribe/.
Webhooks themselves must be created in the dashboard. There is no API for webhook creation.

Authorizations

​
X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Path Parameters

​
id
string
required

Body

application/json

Subscribe a webhook to this conversation.

​
webhookId
string<uuid>
required

ID of an existing webhook to route this conversation to.

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
contact
object
required
​
activeAgent
string
required
read-only
​
whatsappNumber
string
required
read-only
​
chatWindowRemainingTime
string
required
read-only
​
lastMessage
string
required
read-only
​
isHumanTakeover
string
required
read-only
​
active
string
required
read-only
​
routing
string
required
read-only
​
webhookId
string
required
read-only
​
routingOverride
string
required
read-only