Skip to main content
POST
/
v1
/
webhook-endpoints
Create a webhook endpoint
curl --request POST \
  --url https://api.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"
  ],
  "headers": {
    "X-Custom-Header": "my-value"
  },
  "timeout_ms": 5000,
  "enabled": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "enabled": true,
  "event_types": [
    "alerts.triggered"
  ],
  "timeout_ms": 5000,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "signing_secret": "<string>",
  "headers": {}
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
url
string<uri>
required
Pattern: ^https://
​
event_types
enum<string>[]
required
Minimum array length: 1
Available options:
alerts.triggered
​
headers
object
​
timeout_ms
integer
default:5000
Required range: 1000 <= x <= 30000
​
enabled
boolean
default:true

Response

Webhook endpoint created successfully.

​
id
string<uuid>
required
​
name
string
required
Required string length: 1 - 255
​
url
string<uri>
required
​
enabled
boolean
default:true
required
​
event_types
enum<string>[]
required
Available options:
alerts.triggered
​
timeout_ms
integer
default:5000
required
Required range: 1000 <= x <= 30000
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
signing_secret
string
required

Returned only once during endpoint creation. Store it securely.

​
headers
object