Veranstaltungen
Aktualisierte
Die Ereignisressource beschreibt die Nutzlast der an Ihren Webhook-Empfänger gesendeten Anforderungen. Die API zeichnet zuvor gesendete Ereignisse auf, die Sie über die Standardressourcenschnittstelle abfragen können.
Die API versucht, Ereignisse innerhalb weniger Stunden bis zu fünfmal an Ihren Webhook-Empfänger zu übermitteln.
Attribute
| Name | Art | Beschreibung |
|---|---|---|
id | Zeichenfolge | Ressourcenkennung. |
resource | Zeichenfolge, immer event | Ressourcentyp-ID. |
type | Zeichenfolge | Der Ressourcentyp, auf den sich dieses Ereignis bezieht. Am häufigsten wird dies eine task . |
action | Zeichenfolge | Die Aktion, die stattgefunden hat, die dazu geführt hat, dass dieses Ereignis gesendet, dh completed . |
data | verschachtelte Ressource | Die Ressourceninstanz, auf die sich das Ereignis bezieht. |
state | Zeichenfolge | Einer von: pending , delivered , failed . |
retries | int | Die Häufigkeit, mit der die API die Zustellung des Ereignisses wiederholt hat. |
date_created | Terminzeit | Wann wurde die Ressource erstellt. |
date_delivered | Terminzeit | Wann das Ereignis an Ihren Webhook-Empfänger gesendet wurde. |
Typen
-
session.expired: Die Sitzung wurde als abgelaufen markiert. -
poll.created: Die Umfrage wurde erstellt. -
poll.completed: Die Umfrage wurde beendet und alle Ergebnisse wurden veröffentlicht. -
task.created: Die Unteraufgabe "Umfrage" wurde erstellt. -
task.succeeded: Die Umfrage-Unteraufgabe wurde erfolgreich abgeschlossen. -
task.failed: Dietask.failedder Umfrage hat einen Fehlertask.failed.
Aktionen
Das action eines Ereignisses beschreibt die Änderung, die an der Ressource vorgenommen wurde, z. B. created , succeeded oder failed .
Daten
Das Datenfeld enthält die gesamte Ressource, die sich auf das Ereignis bezieht. Dies schließt die verschachtelten Ressourcenattribute ein.
Zustände
-
pending - Die Veranstaltung wird noch zugestellt.
-
delivered - Das Ereignis wurde von einem Webhook-Empfänger empfangen.
-
failed - Das Ereignis konnte nach erneuten Versuchen nicht zugestellt werden.
GET /events/{event ID}
CURL verwenden
curl https://ricloud-api.reincubate.com/events/<event ID> \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud event = ricloud.Event.retrieve(<event ID>)
Liste GET /events
| Name | Art | Beschreibung |
|---|---|---|
type | Zeichenfolge | Filtern nach Ereignistyp. |
action | Zeichenfolge | Nach Ereignisaktion filtern. |
state | Zeichenfolge | Nach Ereignisstatus filtern. |
date_created | Datum / Uhrzeit-Filter | Filtern nach Erstellungsdatum und -zeit der Ressource. |
date_delivered | Datum / Uhrzeit-Filter | Filtern nach Datum und Uhrzeit der Ereignisübermittlung. |
CURL verwenden
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud polls = ricloud.Event.list()
