Отримати вебхук

Заголовки відповіді

• RateLimit-Policy

  Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.

• RateLimit

  Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).

• X-RateLimit-Remaining

  Скільки запитів лишилося за найсуворішим лімітом.

• X-RateLimit-Reset

  Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: WebhookEndpoint

• idintegerобов’язково
• urlstringобов’язково
• descriptionstringобов’язково
• eventsarray of WebhookEventFilterобов’язково
• activebooleanобов’язково
• statusWebhookStatusобов’язково
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 невдалих спроб поспіль; feature_disabled: тариф не містить вебхуків.

• disabled_reasonstring | null

  gone: отримувач відповів 410; manual: вимкнено адміністратором.

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

• disabled_atstring (date-time) | null
• roleWebhookRoleобов’язково
• data_profile_idinteger | null

  Профіль доступу вебхука (null — без профілю, як для ключа API з тією самою роллю).

• collection_idsarray of integerобов’язково

  Колекції, про які вебхук отримує події; порожньо — усі колекції, доступні ролі та профілю доступу.

• tagsarray of stringобов’язково

  Події карток лише для карток із будь-яким із цих тегів; порожньо — без фільтра.

• payloadWebhookPayloadModeобов’язково
• headersarray of WebhookHeaderобов’язково
• auth_typestring | null

  Тип вихідної авторизації (null — немає).

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

• auth_setbooleanобов’язково

  Чи задано вихідну авторизацію (значення ніколи не повертаються).

• previous_secret_valid_untilstring (date-time) | null

  До якого часу доставки підписуються також попереднім секретом (null — перекриття немає).

• healthWebhookHealth
• consecutive_failuresintegerобов’язково
• last_delivery_atstring (date-time) | null
• last_success_atstring (date-time) | null
• last_errorstring | null
• created_byinteger | null
• created_by_namestring | null
• created_atstring (date-time)обов’язково
• updated_atstring (date-time)обов’язково

Заголовки відповіді

• RateLimit-Policy

  Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.

• RateLimit

  Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).

• X-RateLimit-Remaining

  Скільки запитів лишилося за найсуворішим лімітом.

• X-RateLimit-Reset

  Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

Заголовки відповіді

• RateLimit-Policy

  Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.

• RateLimit

  Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).

• X-RateLimit-Remaining

  Скільки запитів лишилося за найсуворішим лімітом.

• X-RateLimit-Reset

  Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

Заголовки відповіді

• RateLimit-Policy

  Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.

• RateLimit

  Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).

• X-RateLimit-Remaining

  Скільки запитів лишилося за найсуворішим лімітом.

• X-RateLimit-Reset

  Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

Заголовки відповіді

• Retry-After

  Кількість секунд, які слід зачекати перед повторним запитом.

• RateLimit-Policy

  Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.

• RateLimit

  Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

• X-RateLimit-Limit

  Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).

• X-RateLimit-Remaining

  Скільки запитів лишилося за найсуворішим лімітом.

• X-RateLimit-Reset

  Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error