Mindbox
Экспорты

Экспорт логов вебхуков

Требования

Настроенная операция с шагом «Экспорт — Выгрузить логи вебхуков».

Для доступа к файлу экспорта нужно право «Экспорт логов интеграций», по умолчанию имеющееся у роли «Владельцы».

Общий контракт постановки задачи экспорта

Общий контракт постановки задачи экспорта описан здесь

Контракт экспорта логов вебхуков

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

JSONJSON
https://api.mindbox.ru/v3/operations/sync?endpointId={endpointId}&operation={operation} Accept: application/json Content-Type: application/json Authorization: SecretKey {Секретный ключ} { "exportId": "<Идентификатор экспорта>", "sinceDateTimeUtc": "<Начальная дата и время вызова вебхука (UTC, YYYY-MM-DD hh:mm)>", "tillDateTimeUtc": "<Конечная дата и время вызова вебхука невключительно (UTC, YYYY-MM-DD hh:mm)>", "isSuccessful": "<Выполнено успешно?>", "webhooks": [ { "ids": { "id": "<Идентификатор вебхука>" } }, { "ids": { "id": "<Идентификатор вебхука>" } } ] }

Во входных параметрах можно указать:

  • Дату «от» в формате UTC. В выгрузку попадут только вызовы, которые появились в логах после этой даты;
  • Дату «до» в формате UTC. Тогда в выгрузку попадут только вызовы, которые появились в логах до этой даты;
  • Выгружать ли только успешные или только ошибочные вызовы;
  • Идентификаторы вебхуков, которые можно найти в их URL

Описание базовых полей логов вебхуков

  • WebhookLogTransactionId: Уникальный идентификатор вызова хука. Совпадает для повторных попыток отправки вебхука
  • WebhookLogStartDateTimeUtc: Время вызова вебхука в UTC
  • WebhookLogWebhookSourceId Уникальный идентификатор блока сценария, из которого вызван вебхук. Включает id сценария, версию и id блока сценария
  • WebhookLogWebhookSourceType: Тип механики, из которой вызван вебхук. Сейчас поддерживается только блок сценария
  • WebhookLogWebhookSourceName: Название механики, из которой вызван вебхук.
  • WebhookLogWebhookSourceUrl: Ссылка на механику, из которой вызван вебхук.
  • WebhookLogWebhookId: Уникальный идентификатор вебхука
  • WebhookLogWebhookName: Название вебхука
  • WebhookLogIntegrationId: Уникальный идентификатор интеграции вебхука
  • WebhookLogIntegrationName: Название интеграции вебхука
  • WebhookLogStatus: Результат вызова вебхука. Успех или ошибка
  • WebhookLogHttpMethod: HTTP метод вебхука
  • WebhookLogUrl: URL адрес вебхука
  • WebhookLogRequestHeaders: Заголовки вызова вебхука
  • WebhookLogRequestBody: Тело вызванного вебхука
  • WebhookLogHTTPStatusCode: Код ответа вебхука
  • WebhookLogResponseHeaders: Заголовки ответа вебхука
  • WebhookLogResponseBody: Тело ответа вебхука
  • WebhookLogRetryNumber: Номер попытки вызова вебхука
Last modified on