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"
}
'
import requests

url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/"

payload = { "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhookId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'webhookId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/"

	payload := strings.NewReader("{\n  \"webhookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/conversations/{id}/subscribe/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhookId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "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