The event store object
A comprehensive list of the event store resource's attributes and relationships
An event store object is returned as part of the response body of each successful retrieve API call to the /api/event_stores
endpoint.
Fields
type
string
event_stores
id
string
The event store unique identifier
links.self
string
The event store endpoint URL
attributes.resource_type
string
The type of the affected resource.
attributes.resource_id
string
The ID of the affected resource.
attributes.event
string
The type of change (one of create or update).
attributes.payload
object
The object changes payload.
attributes.who
object
Information about who triggered the change.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code.
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
meta.mode
string
The resource environment (can be one of test
or live
)
Last updated