← Справочник API
Webhook-эндпоинтыPOST

Создать Webhook-эндпоинт

Создаёт Webhook на абсолютном HTTP(S) URL; для production рекомендуется HTTPS. status: active или inactive. subscribed_events принимает публичные события или ["*"]; max_attempts: 0..5.

https://api.unifyport.ai/v1/webhook-endpoints

Заголовки

X-Api-Key
stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Content-Type
stringобязательно

Используйте application/json при отправке JSON-тела запроса.

Параметры пути

У этого эндпоинта нет параметров пути.

Тело запроса

url
stringобязательно

Абсолютный HTTP(S) URL получателя Webhook; для production рекомендуется HTTPS.

format: uri

status
stringобязательно

Статус эндпоинта: active или inactive.

enum: active, inactive

subscribed_events[]
string[]

Публичные стандартные события, доставляемые на эндпоинт. ["*"] подписывает на все публичные события, но не включает provider.raw_event.

signing_secret
string

Опциональный секрет подписи Webhook. В примерах используйте плейсхолдеры.

retry_policy
object

max_attempts — число повторов после первой доставки: по умолчанию 3, диапазон 0–5; 0 означает только первую доставку.

max_attempts
integer

Число повторов после первой доставки, от 0 до 5.

Тело ответа

id
string

Идентификатор Webhook-эндпоинта (we_...).

url
string

Абсолютный HTTP(S) URL доставки webhook; для production рекомендуется HTTPS.

format: uri

status
string

Статус эндпоинта: active или inactive.

enum: active, inactive

subscribed_events[]
string[]

Публичные стандартные события эндпоинта; ["*"] означает все публичные события без provider.raw_event.

signing_enabled
boolean

true, когда задан секрет подписи и доставки подписываются.

retry_policy
object

max_attempts считает повторы после первой доставки; по умолчанию 3, диапазон 0–5.

max_attempts
integer

Настроенное число повторов после первой доставки, от 0 до 5.

Ответы

201
201 Created

Запрос выполнен. См. пример тела ответа.

400
Bad Request

Тело запроса, путь или параметры некорректны.

401
Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

Запрос

curl -X POST https://api.unifyport.ai/v1/webhook-endpoints \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhook",
  "status": "active",
  "subscribed_events": ["*"],
  "signing_secret": "<WEBHOOK_SIGNING_SECRET>"
}'

Ответ

{
  "data": {
    "id": "we_example",
    "url": "https://example.com/webhook",
    "status": "active",
    "subscribed_events": ["*"],
    "signing_enabled": true,
    "retry_policy": {
      "max_attempts": 3
    }
  }
}