Eventos
El recurso de evento describe la carga útil de las solicitudes enviadas a su receptor de webhook. La API mantiene un registro de los eventos enviados anteriormente que puede consultar a través de la interfaz de recursos estándar.
La API intentará entregar eventos a su receptor de webhook hasta 5 veces en el transcurso de unas pocas horas.
Atributos
nombre | tipo | descripción |
---|---|---|
id | cuerda | Identificador de recursos. |
resource | cadena, siempre event | Identificador de tipo de recurso. |
type | cuerda | El tipo de recurso con el que se relaciona este evento. Muy a menudo, esto será task . |
action | cuerda | La acción que se produjo que llevó a este evento a ser enviado, es decir, completed . |
data | recurso anidado | La instancia de recurso con la que está relacionado el evento. |
state | cuerda | Uno de: pending , delivered , failed . |
retries | En t | El número de veces que la API ha reintentado la entrega del evento. |
date_created | fecha y hora | Cuando el recurso fue creado. |
date_delivered | fecha y hora | Cuando el evento fue entregado a su receptor de webhook. |
Los tipos
-
session.expired
: la sesión ha sido marcada como caducada. -
poll.created
: la encuesta ha sido creada. -
poll.completed
: la encuesta ha finalizado su procesamiento y todos los resultados han sido publicados. -
task.created
: se ha creado la subtarea de encuesta. -
task.succeeded
: la subtarea de encuesta se ha completado con éxito. -
task.failed
: la subtarea de sondeo encontró un error.
Comportamiento
El atributo de action
un evento describe el cambio que se produjo en el recurso, como created
, succeeded
o failed
.
Datos
El campo de datos contendrá la totalidad del recurso relacionado con el evento. Esto incluye los atributos de recursos anidados.
Estados
-
pending
- El evento todavía está en proceso de ser entregado.
-
delivered
- El evento ha sido recibido por un receptor de webhook.
-
failed
- El evento no se pudo entregar después de los reintentos.
Recuperar GET /events/{event ID}
Usando cURL
curl https://ricloud-api.reincubate.com/events/<event ID> \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud event = ricloud.Event.retrieve(<event ID>)
Lista GET /events
nombre | tipo | descripción |
---|---|---|
type | cuerda | Filtrar por tipo de evento. |
action | cuerda | Filtrar por acción del evento. |
state | cuerda | Filtrar por estado del evento. |
date_created | filtro de fecha y hora | Filtrar por fecha y hora de creación de recursos. |
date_delivered | filtro de fecha y hora | Filtrar por fecha y hora de entrega del evento. |
Usando cURL
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud polls = ricloud.Event.list()