webhooks

Создать вебхук

Подписаться на события: новые отзывы, новые ответы, конец цикла сбора.

object_ids сужает подписку до перечисленных объектов; без него события приходят по всем вашим. Подпись доставки проверяется секретом аккаунта — он один на все ваши подписки, см. GET /v3/webhooks/secret.

post/v3/webhooks

Request

Base URL: https://api.rewio.ru
URL: https://api.rewio.ru/v3/webhooks
Auth: API key in header X-API-Key

Request body

targetstring required

HTTPS-адрес, на который приходят события.

object_idsinteger[] nullable

Присылать события только по этим объектам. Не передано — по всем вашим.

event_typesstring[] required

Какие события присылать.

bucket_windowstring

Как часто собирать события в одну доставку.

Example request

{
  "bucket_window": "immediate",
  "event_types": [
    "reviews.new"
  ],
  "object_ids": [
    20
  ],
  "target": "https://example.com/hooks/rewio"
}

Response

Successful Response

idinteger required

Идентификатор подписки.

targetstring required

Адрес доставки.

object_idsinteger[] nullable

Объекты, по которым приходят события. null — по всем.

event_typesstring[] required

События подписки.

bucket_windowstring required

Окно группировки событий в одну доставку.

is_activeboolean required

Включена ли подписка.

failure_countinteger required

Сколько неудачных доставок подряд.

last_failure_atstring date-time nullable

Момент последней неудачи (UTC, ISO 8601).

created_atstring date-time required

Момент создания подписки (UTC, ISO 8601).

updated_atstring date-time required

Момент последнего изменения (UTC, ISO 8601).

Example response

{
  "filters": {
    "allowed_ratings": [
      1,
      2
    ],
    "allowed_sources": [
      "yandex_maps"
    ],
    "has_images": false,
    "has_text": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.