Events

Updated

The event resource describes the payload of requests sent to your webhook receiver. The API keeps a record of previously sent events which you can query for through the standard resource interface.

The API will attempt to deliver events to your webhook receiver up to 5 times over the course of a few hours.

Attributes

name type description
id string Resource identifier.
resource string, always event Resource type identifier.
type string The type of resource this event relates to. Most often, this will be task.
action string The action that occurred which lead to this event being sent, i.e. completed.
data nested resource The resource instance the event is related to.
state string One of: pending, delivered, failed.
retries int The number of times the API has retried delivery of the event.
date_created datetime When the resource was created.
date_delivered datetime When the event was delivered to your webhook receiver.

Types

Event types tend to reflect the API resource type that the event relates to, such as poll or session.

Actions

An event's action attribute describes the change that occurred to the resource, such as created, succeeded or failed.

Data

The data field will contain the entirety of the resource related to the event. This includes the resource attributes nested.

States

pending
The event is still in the process of being delivered.
delivered
The event has been received by a webhook receiver.
failed
The event could not be delivered after retries.

Retrieve GET /events/{event ID}

Using cURL

curl https://ricloud-api.reincubate.com/events/<event ID> \
  -H 'Authorization: Token <your key_token>'

Using ricloud-py

import ricloud

event = ricloud.Event.retrieve(<event ID>)

List GET /events

name type description
type string Filter by event type.
action string Filter by event action.
state string Filter by event state.
date_created datetime filter Filter by resource creation datetime.
date_delivered datetime filter Filter by event delivery datetime.

Using cURL

curl https://ricloud-api.reincubate.com/events \
  -H 'Authorization: Token <your key_token>'

Using ricloud-py

import ricloud

polls = ricloud.Event.list()

How can we help?

Our support team are here to help!

Our office hours are Monday to Friday, 9am to 5pm GMT.

We aim to reply to all messages within one working day.

Get in touch › Our awesome support team

© 2008 - 2019 Reincubate Ltd. All rights reserved. Registered in England and Wales #5189175, VAT GB151788978. Reincubate® is a registered trademark. Privacy & terms. We recommend 2FA. Built with in London.