Événements
Mis à jour
La ressource événement décrit la charge utile des demandes envoyées à votre récepteur webhook. L'API conserve un enregistrement des événements envoyés précédemment que vous pouvez interroger via l'interface de ressource standard.
L'API tentera de transmettre des événements à votre récepteur webhook jusqu'à 5 fois en quelques heures.
Les attributs
| prénom | type | la description |
|---|---|---|
id | chaîne | Identifiant de ressource. |
resource | chaîne, toujours event | Identifiant du type de ressource. |
type | chaîne | Le type de ressource auquel cet événement se rapporte. Le plus souvent, ce sera une task . |
action | chaîne | L'action qui a conduit à l'envoi de cet événement, c'est-à-dire à sa completed . |
data | ressource imbriquée | L'instance de ressource à laquelle l'événement est lié. |
state | chaîne | L'un des suivants: en pending , delivered , failed . |
retries | int | Nombre de fois que l'API a répété la livraison de l'événement. |
date_created | date / heure | Quand la ressource a été créée. |
date_delivered | date / heure | Lorsque l'événement a été livré à votre récepteur webhook. |
Les types
-
session.expired: la session a été marquée comme expirée. -
poll.created: le sondage a été créé. -
poll.completed: le sondage est terminé et tous les résultats ont été publiés. -
task.created: la sous-tâche d'interrogation a été créée. -
task.succeeded: la sous-tâche d'interrogation s'est terminée avec succès. -
task.failed: la sous-tâche d'interrogation a rencontré une erreur.
actes
L'attribut d' action un événement décrit le changement survenu à la ressource, tel que created , succeeded ou failed .
Les données
Le champ de données contiendra l'intégralité de la ressource liée à l'événement. Cela inclut les attributs de ressources imbriqués.
États
-
pending - L'événement est toujours en cours de réalisation.
-
delivered - L'événement a été reçu par un récepteur webhook.
-
failed - L'événement n'a pas pu être livré après de nouvelles tentatives.
Récupérer GET /events/{event ID}
Utiliser cURL
curl https://ricloud-api.reincubate.com/events/<event ID> \ -H 'Authorization: Token <your key_token>'
Utiliser ricloud-py
import ricloud event = ricloud.Event.retrieve(<event ID>)
Liste GET /events
| prénom | type | la description |
|---|---|---|
type | chaîne | Filtrer par type d'événement. |
action | chaîne | Filtrer par action d'événement. |
state | chaîne | Filtrer par état d'événement. |
date_created | filtre datetime | Filtrer par date de création de ressource. |
date_delivered | filtre datetime | Filtrer par date de livraison d'événement. |
Utiliser cURL
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Utiliser ricloud-py
import ricloud polls = ricloud.Event.list()
