イベント
更新しました
イベントリソースはあなたのwebhook受信者に送信されたリクエストのペイロードを記述します。 APIは以前に送信されたイベントの記録を保持しており、これは標準のリソースインターフェイスを介して照会できます。
APIは数時間のうちに最大5回まであなたのwebhook受信機にイベントを配信しようとします。
属性
| 名 | タイプ | 説明 |
|---|---|---|
id | ひも | リソース識別子 |
resource | 文字列、常にevent | リソースタイプ識別子 |
type | ひも | このイベントが関連するリソースの種類。ほとんどの場合、これはtaskになり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}取得し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()