v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB

Create a webhook endpoint

post/v1/webhook-endpoints

Request body

namestring required

urlstring uri required

event_typesWebhookEventType[] required

headersobject

timeout_msinteger

enabledboolean

Example request

{
  "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
}

Response

Webhook endpoint created successfully.

idstring required

namestring required

urlstring uri required

enabledboolean required

event_typesWebhookEventType[] required

headersobject

timeout_msinteger required

created_atstring date-time required

updated_atstring date-time required

signing_secretstring required

Returned only once during endpoint creation. Store it securely.

Example response

{
  "id": "whe_9ZtRcXw3nByK5pVqMaEfJs"
}