Перейти к навигации

Вебхуки

Создайте обработчик вебхуков для необязательных уведомлений о завершении задач BeatAPI.

Сохраните секрет подписи, полученный при создании, проверяйте каждый обратный вызов по исходным байтам тела запроса и используйте опрос состояния как резервный достоверный источник. Правила повторов в рабочей среде приведены в быстром старте.

Аутентификация

AuthorizationBearer

Передавайте API-ключ в виде Authorization: Bearer <BEATAPI_API_KEY>.

Запрос

This endpoint expects an object.
urlstringОбязательныйformat: "uri"

Публичный HTTPS URL обратного вызова, принимающий события задач BeatAPI. Не используйте localhost или URL частной сети.

descriptionstringОпциональный

Необязательная внутренняя метка для идентификации обработчика в аккаунте.

eventslist of enumsОпциональный

События задач для доставки. Если не указано, подписка включает task.succeeded и task.failed.

Допустимые значения:

Ответ

Обработчик вебхуков создан

dataobject

Созданный или полученный обработчик вебхуков. Публичный API возвращает полный секрет подписи при создании и маскирует его в дальнейшем; авторизованный владелец аккаунта в панели управления может явно запросить его повторный показ.

Ошибки

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error