The event object

An event is created and sent via webhook when an object is created or updated. Each event has a topic, corresponding to the type of the object that has been created or updated, and a type, corresponding to the nature of the event itself. The object created or updated is nested into the event object.

You can find the list of all event types and events in the Event types section.

AttributeDescription
id
string		The UUID of the event.
object
string		Here event.
topic
string		The topic of this event.
type
string		The type of this event.
status
string		The status of this event.
status_details
string		The details of the status of this event.
created_at
datetime		The UTC timestamp of the creation of this event.
data
object		Contains the object that has been created or updated.
related_object_id
string		The UUID of the object associated with the event.
related_object_type
string		The type of the object associated with the event.

Below is an example of an event:

{
  "id": "cf1ce879-f779-4b4b-bd9a-0747ef3dc18b",
  "object": "event",
  "topic": "file",
  "type": "created",
  "status": "delivered",
  "status_details": "",
  "related_object_id": "6312697e-a11f-4f11-84cf-8e32a9cfc289",
  "related_object_type": "file",
  "created_at": "2021-10-18T09:57:41.586741Z",
  "data": {
    "id": "6312697e-a11f-4f11-84cf-8e32a9cfc289",
    "size": 2605,
    "format": "pacs.008",
    "object": "file",
    "status": "created",
    "summary": {},
    "category": "payment_file",
    "filename": "211018231401AecA.1634551061.xml",
    "bank_data": {
      "message_id": ""
    },
    "direction": "outgoing",
    "created_at": "2021-10-18T09:57:41.559011Z",
    "status_details": "generated on 2021-10-18",
    "connected_account": "22222222-0000-0000-0000-000000000001"
  },
}