`POST /v1/webhook-endpoints`

Используйте описанные поля и разрешения для этого эндпоинта HTTP.

Пример запроса#

curl -X POST 'https://platform.tongai.io/v1/webhook-endpoints' \  -H "Authorization: Bearer $TONG_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: 45be69f1-c266-4a09-a82c-bf3c6303eb03" \  -d '{  "url": "https://your-app.example/events",  "events": [    "operation.accepted"  ]}'

Настройки

curl --version

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

Используйте серверный API-ключ для своего аккаунта или OAuth для аккаунта каждого клиента. Не передавайте ключи в запросах модели или аргументах инструментов.

webhooks:manageoperations:read

Параметры#

Idempotency-KeystringОбязательно

UUID, например e8aa0a87-6cd9-42eb-975a-b72bf43218c8.

Тело запроса#

application/json

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

Формат: uri.

Максимальная длина: 2000 символов.

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

Минимум элементов: 1.

Максимум элементов: 14.

Схема ответа#

Ответ

JSON

{}

`HTTP 201`

application/json

object

Ошибки и ограничения#

HTTP	Ошибка	Восстановление
`400`	Недопустимый запрос`REQUEST_INVALID`	Перед повтором исправьте поля, указанные в ошибке.
`401`	Недействительные учётные данные`CREDENTIAL_INVALID`	Проверьте учётные данные, срок действия и отзыв доступа.
`402`	Недостаточно кредитов`INSUFFICIENT_CREDITS`	Пополните кредиты аккаунта, которому принадлежат учётные данные, и продолжите сохранённую работу.
`403`	Доступ запрещён`SCOPE_REQUIRED`	Используйте учётные данные с нужными разрешениями и доступом к выбранному ресурсу.
`404`	Ресурс недоступен`RESOURCE_UNAVAILABLE`	Проверьте ID ресурса и его принадлежность авторизованному аккаунту.
`409`	Конфликт намерений`IDEMPOTENCY_CONFLICT`	Повторно используйте намерение только с исходным запросом. Для другого действия создайте новый UUID.
`429`	Превышен лимит частоты`RATE_LIMITED`	Подождите время из Retry-After, прежде чем повторить тот же запрос.
`503`	Временно недоступно`DEPENDENCY_UNAVAILABLE`	Выждите Retry-After и повторите с тем же намерением. После тайм-аута проверьте сохранённую операцию.

АутентификацияAPI-ключи расходуют кредиты аккаунта-владельца. OAuth позволяет каждому пользователю тратить свои кредиты.Ошибки и ограничения частотыИзучите ошибки, безопасно повторяйте запросы и восстанавливайте неудачные генерации.Запросы и журналыПринятый запрос не означает завершённую генерацию. Отслеживайте сохранённое задание до готовности результата.