Eventos
Atualizada
O recurso de evento descreve a carga útil de solicitações enviadas ao seu receptor de webhook. A API mantém um registro de eventos enviados anteriormente que você pode consultar por meio da interface de recursos padrão.
A API tentará entregar eventos ao seu receptor de webhook até 5 vezes ao longo de algumas horas.
Atributos
| nome | tipo | descrição |
|---|---|---|
id | corda | Identificador de recursos. |
resource | string, sempre event | Identificador de tipo de recurso. |
type | corda | O tipo de recurso a que este evento se refere. Na maioria das vezes, isso será task . |
action | corda | A ação ocorrida que levou a esse evento ser enviado, ou seja, completed . |
data | recurso aninhado | A instância do recurso ao qual o evento está relacionado. |
state | corda | Um dos seguintes: pending , delivered , failed . |
retries | int | O número de vezes que a API tentou enviar novamente o evento. |
date_created | data hora | Quando o recurso foi criado. |
date_delivered | data hora | Quando o evento foi entregue ao seu receptor de webhook. |
Tipos
-
session.expired: a sessão foi marcada como expirada. -
poll.created: a pesquisa foi criada. -
poll.completed: a pesquisa terminou o processamento e todos os resultados foram publicados. -
task.created: a subtarefa de pesquisa foi criada. -
task.succeeded: atask.succeededda pesquisa foi concluída com êxito. -
task.failed: atask.failedda pesquisa encontrou um erro.
Ações
O atributo de action um evento descreve a alteração que ocorreu no recurso, como created , com succeeded ou failed .
Dados
O campo de dados conterá a totalidade do recurso relacionado ao evento. Isso inclui os atributos de recursos aninhados.
Estados
-
pending - O evento ainda está em processo de entrega.
-
delivered - O evento foi recebido por um receptor de webhook.
-
failed - O evento não pôde ser entregue após novas tentativas.
Recuperar GET /events/{event ID}
Usando 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>)
Listar GET /events
| nome | tipo | descrição |
|---|---|---|
type | corda | Filtrar por tipo de evento. |
action | corda | Filtrar por ação de evento. |
state | corda | Filtrar por estado do evento. |
date_created | filtro de data e hora | Filtrar por datetime de criação de recurso. |
date_delivered | filtro de data e hora | Filtrar por data e hora de entrega de evento. |
Usando cURL
curl https://ricloud-api.reincubate.com/events \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud polls = ricloud.Event.list()
