События
обновленный
Ресурс события описывает полезную нагрузку запросов, отправленных вашему получателю webhook. API хранит записи о ранее отправленных событиях, которые вы можете запросить через стандартный интерфейс ресурсов.
API будет пытаться доставлять события на ваш приемник webhook до 5 раз в течение нескольких часов.
Атрибуты
| название | тип | описание |
|---|---|---|
id | строка | Идентификатор ресурса. |
resource | строка, всегда event | Идентификатор типа ресурса. |
type | строка | Тип ресурса, к которому относится это событие. Чаще всего это будет task . |
action | строка | Произошедшее действие, которое привело к отправке этого события, т.е. completed . |
data | вложенный ресурс | Экземпляр ресурса, к которому относится событие. |
state | строка | Один из: в pending , delivered , failed . |
retries | ИНТ | Сколько раз API повторял доставку события. |
date_created | Дата и время | Когда ресурс был создан. |
date_delivered | Дата и время | Когда событие было доставлено на ваш приемник webhook. |
Типы
-
session.expired: сеанс был помечен как просроченный. -
poll.created: опрос был создан. -
poll.completed: опрос завершил обработку, и все результаты были опубликованы. -
task.created:task.createdопроса создана. -
task.succeeded:task.succeededопроса успешно завершена. -
task.failed: в подзадаче опроса обнаружена ошибка.
действия
Атрибут action события описывает изменение, произошедшее с ресурсом, например, created , succeeded или failed .
Данные
Поле данных будет содержать весь ресурс, связанный с событием. Это включает в себя атрибуты ресурса, вложенные.
состояния
-
pending - Событие все еще находится в процессе доставки.
-
delivered - Событие получено получателем от веб-крючка.
-
failed - Событие не может быть доставлено после повторных попыток.
Получить GET /events/{event ID}
Использование cURL
curl https://ricloud-api.reincubate.com/events/<event ID> \ -H 'Authorization: Token <your key_token>'
Использование ricloud-py
import ricloud event = ricloud.Event.retrieve(<event ID>)
Список GET /events
| название | тип | описание |
|---|---|---|
type | строка | Фильтр по типу события. |
action | строка | Фильтровать по событию. |
state | строка | Фильтр по состоянию события. |
date_created | фильтр даты и времени | Фильтр по дате создания ресурса. |
date_delivered | фильтр даты и времени | Фильтр по дате и времени доставки события. |
Использование cURL
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Использование ricloud-py
import ricloud polls = ricloud.Event.list()
