REST endpoints

Update SIP hooks

Adds or replaces SIP hooks in the cache. Hooks with matching hosts (case-insensitive) will be replaced. Hosts defined in the application configuration cannot be modified. The changes take effect immediately and persist across server restarts.

Note: Secrets are NOT stored in the cache. Runtime-added hooks will use the global hook_secret from the server configuration.

Request Body

Array of hook entries with host and url fields.

Returns

200 OK - Updated list of SIP hooks
400 Bad Request - If validation fails (e.g., duplicate hosts)
500 Internal Server Error - If writing the cache fails

POST

sip

hooks

Updates SIP hooks.

curl --request POST \
  --url https://api.sayna.ai/sip/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hooks": [
    {
      "auth_id": "tenant-123",
      "host": "example.com",
      "url": "https://webhook.example.com/events"
    }
  ]
}
'

import requests

url = "https://api.sayna.ai/sip/hooks"

payload = { "hooks": [
        {
            "auth_id": "tenant-123",
            "host": "example.com",
            "url": "https://webhook.example.com/events"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hooks: [
      {
        auth_id: 'tenant-123',
        host: 'example.com',
        url: 'https://webhook.example.com/events'
      }
    ]
  })
};

fetch('https://api.sayna.ai/sip/hooks', 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://api.sayna.ai/sip/hooks",
  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([
    'hooks' => [
        [
                'auth_id' => 'tenant-123',
                'host' => 'example.com',
                'url' => 'https://webhook.example.com/events'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.sayna.ai/sip/hooks"

	payload := strings.NewReader("{\n  \"hooks\": [\n    {\n      \"auth_id\": \"tenant-123\",\n      \"host\": \"example.com\",\n      \"url\": \"https://webhook.example.com/events\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.sayna.ai/sip/hooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hooks\": [\n    {\n      \"auth_id\": \"tenant-123\",\n      \"host\": \"example.com\",\n      \"url\": \"https://webhook.example.com/events\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sayna.ai/sip/hooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hooks\": [\n    {\n      \"auth_id\": \"tenant-123\",\n      \"host\": \"example.com\",\n      \"url\": \"https://webhook.example.com/events\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "hooks": [
    {
      "auth_id": "tenant-123",
      "host": "example.com",
      "url": "https://webhook.example.com/events"
    }
  ]
}

{
  "error": "Duplicate host detected: example.com"
}

{
  "error": "Duplicate host detected: example.com"
}

{
  "error": "Duplicate host detected: example.com"
}

Adds or replaces SIP webhook forwarding entries at runtime. Changes take effect immediately and persist across server restarts.

Request body

Array of hook entries with:

host - Host pattern for matching SIP domains (case-insensitive)
url - HTTPS URL to forward webhook events to
auth_id - Tenant identifier for room ownership

The auth_id field is required when AUTH_REQUIRED=true. It determines which tenant owns rooms created from inbound SIP calls to this host.

Behavior

Hooks with matching hosts (case-insensitive) are replaced; others are added.
Hosts defined in the application configuration cannot be modified via this endpoint.
Secrets are NOT stored in the cache. Runtime-added hooks use the global hook_secret from server configuration.

Error responses

Status	Condition
`400 Bad Request`	Validation failed (duplicate hosts, non-HTTPS URLs, missing `auth_id` when required).
`405 Method Not Allowed`	Attempted to modify a host defined in application config.
`500 Internal Server Error`	Failed to write hooks cache.

Authorizations

Authorization

string

header

required

Authentication token for protected endpoints. Can be provided as Authorization: Bearer <token> or ?api_key=<token>. Required when AUTH_REQUIRED is enabled.

Body

application/json

Request body for updating SIP hooks.

Contains a list of SIP webhook configurations to add or replace.

hooks

object[]

List of SIP hooks to add or replace. Hooks with matching hosts (case-insensitive) will be replaced.

Show child attributes

Response

Updated list of SIP hooks

Response body for SIP hooks operations.

hooks

object[]

required

List of all configured SIP hooks

Show child attributes

Delete SIP hooksRemoves the specified hosts from the cache. Hosts defined in the application configuration cannot be removed. If a host exists in the original server configuration, it will revert to its config value after deletion of a cached override. Hosts that only exist in cache will be completely removed. The changes take effect immediately and persist across server restarts. # Request Body Array of host names to remove (case-insensitive). # Returns * `200 OK` - Updated list of SIP hooks after deletion * `400 Bad Request` - If the hosts array is empty * `500 Internal Server Error` - If writing the cache fails

Updates SIP hooks.

curl --request POST \
  --url https://api.sayna.ai/sip/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hooks": [
    {
      "auth_id": "tenant-123",
      "host": "example.com",
      "url": "https://webhook.example.com/events"
    }
  ]
}
'

import requests

url = "https://api.sayna.ai/sip/hooks"

payload = { "hooks": [
        {
            "auth_id": "tenant-123",
            "host": "example.com",
            "url": "https://webhook.example.com/events"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hooks: [
      {
        auth_id: 'tenant-123',
        host: 'example.com',
        url: 'https://webhook.example.com/events'
      }
    ]
  })
};

fetch('https://api.sayna.ai/sip/hooks', 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://api.sayna.ai/sip/hooks",
  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([
    'hooks' => [
        [
                'auth_id' => 'tenant-123',
                'host' => 'example.com',
                'url' => 'https://webhook.example.com/events'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.sayna.ai/sip/hooks"

	payload := strings.NewReader("{\n  \"hooks\": [\n    {\n      \"auth_id\": \"tenant-123\",\n      \"host\": \"example.com\",\n      \"url\": \"https://webhook.example.com/events\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.sayna.ai/sip/hooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hooks\": [\n    {\n      \"auth_id\": \"tenant-123\",\n      \"host\": \"example.com\",\n      \"url\": \"https://webhook.example.com/events\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sayna.ai/sip/hooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hooks\": [\n    {\n      \"auth_id\": \"tenant-123\",\n      \"host\": \"example.com\",\n      \"url\": \"https://webhook.example.com/events\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "hooks": [
    {
      "auth_id": "tenant-123",
      "host": "example.com",
      "url": "https://webhook.example.com/events"
    }
  ]
}

{
  "error": "Duplicate host detected: example.com"
}

{
  "error": "Duplicate host detected: example.com"
}

{
  "error": "Duplicate host detected: example.com"
}

​Request body

​Behavior

​Error responses

Authorizations

Body

Response

Request body

Behavior

Error responses