Skip to content

Webhook для уведомлений

Сервис поддерживает webhook-уведомления о завершении обработки задачи.

Как это работает

  1. Вы указываете свой webhook-URL через метод /webhook
  2. После завершения задачи сервис отправляет POST-запрос на этот адрес

ВАЖНО:
- webhook поддерживает только HTTPS-адреса
- Адрес должен быть полным - Сервер клиента должен возвращать HTTP 200 OK на успешное получение уведомления - Если сервер не ответит кодом 200 на POST-запрос, будет совершено еще 2 попытки отправки результата с интервалом в минуту

Правильные адреса вебхука:

  • https://my-domain.com/webhook
  • https://my-domain.com/api/webhook

Неправильные адреса вебхука:

  • http://my-domain.com/webhook
  • my-domain.com/webhook

Структура уведомления

{
  "status": "success",
  "code": 0,
  "recognition_result": {
      data
  }
}

Пример эндпоинта для вебхука

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route("/webhook", methods=["POST"])
def webhook():
    data = request.get_json()
    print(f"Webhook received keys: {data.keys()}")
    return "OK", 200

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=5000)