活动
更新
事件资源描述发送到webhook接收器的请求的有效负载。 API会保留先前发送的事件的记录，您可以通过标准资源接口查询这些事件。
API会在几个小时内尝试向您的webhook接收器发送最多5次事件。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
id | 串 | 资源标识符。 |
resource | string，always event | 资源类型标识符。 |
type | 串 | 此事件涉及的资源类型。大多数情况下，这将是task 。 |
action | 串 | 发生导致此事件发送，即completed 。 |
data | 嵌套资源 | 事件与之相关的资源实例。 |
state | 串 | 其中之一： pending ， delivered ， failed 。 |
retries | INT | API重试事件传递的次数。 |
date_created | 约会时间 | 资源创建时。 |
date_delivered | 约会时间 | 事件发送到您的webhook接收器时。 |
类型
-
session.expired：会话已被标记为已过期。 -
poll.created：民意调查已创建。 -
poll.completed：民意调查已完成处理并且所有结果都已发布。 -
task.created：轮询子任务已创建。 -
task.succeeded：轮询子任务已成功完成。 -
task.failed：轮询子任务遇到错误。
操作
事件的action属性描述了资源发生的更改，例如已created ， succeeded或failed 。
数据
数据字段将包含与事件相关的全部资源。这包括嵌套的资源属性。
状态
-
pending - 该事件仍在交付过程中。
-
delivered - 该事件已由webhook接收器接收。
-
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()
