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

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

Создаёт получатель Webhook. subscribed_events принимает стандартные имена событий платформы (например, message.received, account.status.updated); используйте ["*"] для подписки на все события. Неизвестные имена событий отклоняются. signing_secret опционально — если поле не указано или пустое, подпись для эндпоинта отключается. retry_policy.max_attempts должно быть неотрицательным целым числом; 0 отключает повторы; нецелые значения отклоняются.

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

Заголовки

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

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

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

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

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

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

Тело запроса

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

HTTPS-эндпоинт, принимающий Webhook-события.

status
string

Статус эндпоинта, обычно active или inactive.

subscribed_events
string[]

Типы событий, доставляемые на эндпоинт. Используйте ["*"] для подписки на все события; полный список имён — в каталоге стандартных событий.

signing_secret
string

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

retry_policy
object

Настройки повторов, например max_attempts.

Тело ответа

id
string

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

url
string

HTTPS URL, принимающий доставку webhook.

status
string

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

subscribed_events
string[]

Типы событий, доставляемые на эндпоинт; ["*"] означает все события.

signing_enabled
boolean

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

retry_policy
object

Настройки повторов, например max_attempts.

Ответы

201
201 Created

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

400
Bad Request

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

401
Unauthorized

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

409
Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500
Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

Запрос

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