ВебхукиЗарегистрировать вебхук
Назад к Sofia

Вебхуки

Зарегистрировать вебхук

Регистрирует URL https, который Sofia вызывает с подписанным JSON-событием, до пяти повторов при сбое. Секрет виден один раз; не больше 10 вебхуков.

POSThttps://api.sofia-post.com/api/v1/webhooks
POST/v1/webhooks

Этот запрос действует на ваш реальный аккаунт.

curl -X POST 'https://api.sofia-post.com/api/v1/webhooks' \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://crm.example.com/hooks/sofia","events":["post.published"]}'

Авторизации

  • Authorizationstringобязательно

    Ваш личный ключ или токен доступа OAuth, отправляется как Bearer <token>.

Тело

application/json

  • urlstringобязательно

    Адрес https, который вызывает Sofia. Хост, разрешающийся в приватный, loopback или link-local адрес, отклоняется

  • eventsstring[]обязательно

    События для получения

Ответ

201application/json

Вебхук и его секрет подписи, показанный только один раз.

  • idstringобязательно

    Идентификатор вебхука.

  • urlstringобязательно

    Адрес, который вызывает Sofia

  • eventsstring[]обязательно

    Подписанные события

  • createdAtstring<date-time>обязательно

    Когда вебхук был зарегистрирован

  • secretstringобязательно

    Ключ HMAC-SHA256, которым подписывается каждая доставка (Sofia-Signature). Показывается только один раз

400

webhook_url_invalid: не https либо приватный, loopback или link-local хост. webhook_event_invalid: неизвестное событие или их нет.

401

Токен отсутствует, неизвестен, просрочен или отозван.

403

У токена нет разрешения webhooks:write.

409

webhook_limit_reached: уже 10 вебхуков.

4XXapplication/json

Любая другая ошибка в конверте ошибки.