Evenementen
bijgewerkt
De gebeurtenisbron beschrijft de payload van verzoeken die naar uw webhook-ontvanger zijn verzonden. De API houdt een registratie bij van eerder verzonden gebeurtenissen waar u naar kunt zoeken via de standaardresource-interface.
De API zal proberen om gebeurtenissen binnen een paar uur maximaal 5 keer aan uw webhook-ontvanger te leveren.
attributen
| naam | type | Omschrijving |
|---|---|---|
id | draad | Bron-ID. |
resource | string, altijd event | Resource type identifier. |
type | draad | Het type resource waarop deze gebeurtenis betrekking heeft. Meestal zal dit een task . |
action | draad | De actie die plaatsvond die ertoe leidde dat deze gebeurtenis werd verzonden, dwz completed . |
data | geneste bron | De broninstantie waaraan de gebeurtenis is gerelateerd. |
state | draad | Eén van: in pending , delivered , failed . |
retries | int | Het aantal keren dat de API de levering van de gebeurtenis opnieuw heeft geprobeerd. |
date_created | datum Tijd | Wanneer de resource is gemaakt. |
date_delivered | datum Tijd | Wanneer het evenement werd afgeleverd bij uw webhook-ontvanger. |
Types
-
session.expired: de sessie is gemarkeerd als verlopen. -
poll.created: de poll is aangemaakt. -
poll.completed: de poll is verwerkt en alle resultaten zijn gepubliceerd. -
task.created: de poll-task.createdis gemaakt. -
task.succeeded: de poll-task.succeededis succesvol afgerond. -
task.failed: de poll-task.failedheeft een fout aangetroffen.
acties
Een gebeurtenis action attribuut dat aangeeft dat kwam bij de bron, zoals created , succeeded of failed .
Gegevens
Het gegevensveld bevat de volledige bron van de gebeurtenis. Dit omvat de geneste resourcekenmerken.
Staten
-
pending - Het evenement wordt nog steeds afgeleverd.
-
delivered - Het evenement is ontvangen door een webhook-ontvanger.
-
failed - Het evenement kon niet worden geleverd na opnieuw proberen.
Ophalen GET /events/{event ID}
CURL gebruiken
curl https://ricloud-api.reincubate.com/events/<event ID> \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud event = ricloud.Event.retrieve(<event ID>)
Lijst GET /events
| naam | type | Omschrijving |
|---|---|---|
type | draad | Filteren op gebeurtenistype. |
action | draad | Filter op gebeurtenisactie. |
state | draad | Filteren op gebeurtenisstatus. |
date_created | datetime filter | Filteren op bronvervaardiging datetime. |
date_delivered | datetime filter | Filteren op gebeurtenisaflevering datetime. |
CURL gebruiken
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud polls = ricloud.Event.list()