eventi
La risorsa evento descrive il carico utile delle richieste inviate al ricevitore webhook. L'API tiene un registro degli eventi inviati in precedenza che puoi richiedere tramite l'interfaccia delle risorse standard.
L'API tenterà di consegnare eventi al tuo ricevitore webhook fino a 5 volte nel corso di poche ore.
attributi
nome | genere | descrizione |
---|---|---|
id | stringa | Identificatore di risorse |
resource | stringa, sempre event | Identificativo del tipo di risorsa |
type | stringa | Il tipo di risorsa a cui questo evento si riferisce. Molto spesso, questo sarà task . |
action | stringa | L'azione che si è verificata che ha portato a questo evento inviato, cioè completed . |
data | risorsa nidificata | L'istanza della risorsa a cui è correlato l'evento. |
state | stringa | Uno di: in pending , delivered , failed . |
retries | int | Il numero di volte in cui l'API ha ritentato la consegna dell'evento. |
date_created | appuntamento | Quando la risorsa è stata creata. |
date_delivered | appuntamento | Quando l'evento è stato consegnato al tuo ricevitore webhook. |
tipi
-
session.expired
: la sessione è stata contrassegnata come scaduta. -
poll.created
: il sondaggio è stato creato. -
poll.completed
: il sondaggio ha terminato l'elaborazione e tutti i risultati sono stati pubblicati. -
task.created
: l'attività secondaria di polling è stata creata. -
task.succeeded
: l'attività secondaria di polling è stata completata correttamente. -
task.failed
: l'attività secondaria di polling ha riscontrato un errore.
Azioni
L'attributo action
un evento descrive la modifica apportata alla risorsa, ad esempio created
, succeeded
o failed
.
Dati
Il campo dati conterrà la totalità della risorsa relativa all'evento. Questo include gli attributi della risorsa nidificati.
stati
-
pending
- L'evento è ancora in fase di consegna.
-
delivered
- L'evento è stato ricevuto da un ricevitore webhook.
-
failed
- L'evento non può essere consegnato dopo i tentativi.
Recupera GET /events/{event ID}
Utilizzando cURL
curl https://ricloud-api.reincubate.com/events/<event ID> \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud event = ricloud.Event.retrieve(<event ID>)
Elenco GET /events
nome | genere | descrizione |
---|---|---|
type | stringa | Filtra per tipo di evento. |
action | stringa | Filtra per azione dell'evento. |
state | stringa | Filtra per stato evento. |
date_created | filtro datetime | Filtra per creazione di data e ora. |
date_delivered | filtro datetime | Filtra per data di consegna dell'evento. |
Utilizzando cURL
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud polls = ricloud.Event.list()