Events

Events are used to inform users about changes that have happened within a provider's platform. These events encompass a wide range of changes, such as the creation of a ticket, the addition or removal of products to a ticket, the closure of a ticket, the cancellation of a ticket, and more. Events can be accessed not only through the Partner API but also by subscribing to websocket channels for real-time monitoring. For more information, see the Partner Websocket API documentation for details.

Event

id

string <ulid>

Event identifier.

type

string <= 255 characters

Event type.

occurred_at

string <date-time>

The date-time this event occurred.

object

Event payload.

	object (PayloadTicket)
	object or null (PayloadParentTicket)
	object (PayloadCustomer)

{"id": "01HWTCTT509VV8X9XYGPTR5N8Q",
"type": "tickets.ticket.created",
"occurred_at": "2019-08-24T14:15:22Z",
"payload": {"customer": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Mechanics Inc."
},
"ticket": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": 12456234,
"ticket_number": 72456234
},
"parent_ticket": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ticket_number": 72456234
}
}
}

Retrieve all events [BETA]

Retrieve a list of events that have happened in the system.

SecurityOAuth2 and ApiKey

Request

query Parameters

after_id	string <uuid> Return all events that have happened after the event with provided identifier.
limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
occurred_after	string <date-time> Return all events that have happened after provided date-time.
type	string Return all events of the provided type.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
property name* additional property	any

Array of objects (Event) >= 0 items

List of events.

Array (>= 0 items)

id	string <ulid> Event identifier.
type	string <= 255 characters Event type. tickets.ticket.created
occurred_at	string <date-time> The date-time this event occurred.
	object Event payload.

default

An error occurred - see status code and problem response for more information.

get/v2/system/events

Response samples

200
default

application/json

{"query": {"limit": 25
},
"result": [{"id": "01HWTCTT509VV8X9XYGPTR5N8Q",
"type": "tickets.ticket.created",
"occurred_at": "2019-08-24T14:15:22Z",
"payload": {"customer": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Mechanics Inc."
},
"ticket": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": 12456234,
"ticket_number": 72456234
},
"parent_ticket": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ticket_number": 72456234
}
}
}
]
}