Create a webhook endpoint
POST
/
v1
/
webhook-endpoints
Create a webhook endpoint
curl --request POST \
--url https://api.us.poly.ai/v1/webhook-endpoints \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Production alerts",
"url": "https://example.com/webhooks/polyai",
"event_types": [
"alerts.triggered",
"alerts.resolved"
],
"headers": {
"X-Custom-Header": "my-value"
},
"timeout_ms": 5000,
"enabled": true
}
'import requests
url = "https://api.us.poly.ai/v1/webhook-endpoints"
payload = {
"name": "Production alerts",
"url": "https://example.com/webhooks/polyai",
"event_types": ["alerts.triggered", "alerts.resolved"],
"headers": { "X-Custom-Header": "my-value" },
"timeout_ms": 5000,
"enabled": True
}
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({
name: 'Production alerts',
url: 'https://example.com/webhooks/polyai',
event_types: ['alerts.triggered', 'alerts.resolved'],
headers: {'X-Custom-Header': 'my-value'},
timeout_ms: 5000,
enabled: true
})
};
fetch('https://api.us.poly.ai/v1/webhook-endpoints', 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.us.poly.ai/v1/webhook-endpoints",
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([
'name' => 'Production alerts',
'url' => 'https://example.com/webhooks/polyai',
'event_types' => [
'alerts.triggered',
'alerts.resolved'
],
'headers' => [
'X-Custom-Header' => 'my-value'
],
'timeout_ms' => 5000,
'enabled' => true
]),
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://api.us.poly.ai/v1/webhook-endpoints"
payload := strings.NewReader("{\n \"name\": \"Production alerts\",\n \"url\": \"https://example.com/webhooks/polyai\",\n \"event_types\": [\n \"alerts.triggered\",\n \"alerts.resolved\"\n ],\n \"headers\": {\n \"X-Custom-Header\": \"my-value\"\n },\n \"timeout_ms\": 5000,\n \"enabled\": true\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://api.us.poly.ai/v1/webhook-endpoints")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production alerts\",\n \"url\": \"https://example.com/webhooks/polyai\",\n \"event_types\": [\n \"alerts.triggered\",\n \"alerts.resolved\"\n ],\n \"headers\": {\n \"X-Custom-Header\": \"my-value\"\n },\n \"timeout_ms\": 5000,\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/webhook-endpoints")
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 \"name\": \"Production alerts\",\n \"url\": \"https://example.com/webhooks/polyai\",\n \"event_types\": [\n \"alerts.triggered\",\n \"alerts.resolved\"\n ],\n \"headers\": {\n \"X-Custom-Header\": \"my-value\"\n },\n \"timeout_ms\": 5000,\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "whe_9ZtRcXw3nByK5pVqMaEfJs",
"name": "<string>",
"url": "<string>",
"enabled": true,
"event_types": [],
"timeout_ms": 5000,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"signing_secret": "<string>",
"headers": {}
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}Authorizations
Body
application/json
Required string length:
1 - 255Pattern:
^https://Minimum array length:
1Available options:
alerts.triggered, alerts.resolved Show child attributes
Show child attributes
Required range:
1000 <= x <= 30000Response
Webhook endpoint created successfully.
Pattern:
^whe_[A-Za-z0-9]+$Example:
"whe_9ZtRcXw3nByK5pVqMaEfJs"
Required string length:
1 - 255Available options:
alerts.triggered, alerts.resolved Required range:
1000 <= x <= 30000Returned only once during endpoint creation. Store it securely.
Show child attributes
Show child attributes
Last modified on March 19, 2026
Was this page helpful?
⌘I
Create a webhook endpoint
curl --request POST \
--url https://api.us.poly.ai/v1/webhook-endpoints \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Production alerts",
"url": "https://example.com/webhooks/polyai",
"event_types": [
"alerts.triggered",
"alerts.resolved"
],
"headers": {
"X-Custom-Header": "my-value"
},
"timeout_ms": 5000,
"enabled": true
}
'import requests
url = "https://api.us.poly.ai/v1/webhook-endpoints"
payload = {
"name": "Production alerts",
"url": "https://example.com/webhooks/polyai",
"event_types": ["alerts.triggered", "alerts.resolved"],
"headers": { "X-Custom-Header": "my-value" },
"timeout_ms": 5000,
"enabled": True
}
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({
name: 'Production alerts',
url: 'https://example.com/webhooks/polyai',
event_types: ['alerts.triggered', 'alerts.resolved'],
headers: {'X-Custom-Header': 'my-value'},
timeout_ms: 5000,
enabled: true
})
};
fetch('https://api.us.poly.ai/v1/webhook-endpoints', 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.us.poly.ai/v1/webhook-endpoints",
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([
'name' => 'Production alerts',
'url' => 'https://example.com/webhooks/polyai',
'event_types' => [
'alerts.triggered',
'alerts.resolved'
],
'headers' => [
'X-Custom-Header' => 'my-value'
],
'timeout_ms' => 5000,
'enabled' => true
]),
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://api.us.poly.ai/v1/webhook-endpoints"
payload := strings.NewReader("{\n \"name\": \"Production alerts\",\n \"url\": \"https://example.com/webhooks/polyai\",\n \"event_types\": [\n \"alerts.triggered\",\n \"alerts.resolved\"\n ],\n \"headers\": {\n \"X-Custom-Header\": \"my-value\"\n },\n \"timeout_ms\": 5000,\n \"enabled\": true\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://api.us.poly.ai/v1/webhook-endpoints")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production alerts\",\n \"url\": \"https://example.com/webhooks/polyai\",\n \"event_types\": [\n \"alerts.triggered\",\n \"alerts.resolved\"\n ],\n \"headers\": {\n \"X-Custom-Header\": \"my-value\"\n },\n \"timeout_ms\": 5000,\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/webhook-endpoints")
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 \"name\": \"Production alerts\",\n \"url\": \"https://example.com/webhooks/polyai\",\n \"event_types\": [\n \"alerts.triggered\",\n \"alerts.resolved\"\n ],\n \"headers\": {\n \"X-Custom-Header\": \"my-value\"\n },\n \"timeout_ms\": 5000,\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "whe_9ZtRcXw3nByK5pVqMaEfJs",
"name": "<string>",
"url": "<string>",
"enabled": true,
"event_types": [],
"timeout_ms": 5000,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"signing_secret": "<string>",
"headers": {}
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}
