Events API

Fetch

Fetch an Event

fetchEvent

GET /event/{tenantLocator}/events/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EventResponse
Security Group:events   Permission:read

Fetch Events for an API Request

fetchEventsForARequest

GET /event/{tenantLocator}/events/request/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EventResponse[]
Security Group:events   Permission:read

Fetch Multiple Events

fetchMultipleEvents

GET /event/{tenantLocator}/events/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
startTimestamp	query	datetime?	optional
endTimestamp	query	datetime?	optional
type	query	string?	optional
pageSize	query	int?	optional
pagingToken	query	string?	optional

Response:EventStreamResponse
Security Group:events   Permissions:read,list

EventStreamResponse

required
pagingToken string
events EventResponse[]

EventResponse

required
locator string
userLocator uuid
requestId string
Identifier of the transaction request that triggered the event
timestamp datetime
type string
data map<string,object>

Note

Custom events generated from plugin code will be added to the event stream even if the operation associated with that plugin call has failed.

Note

For events generated from API calls, The timestamp and ordering of events in the event stream are dependent on the completion time of the call. It is possible for events from an API call made before another to come after those events from the subsequent API call, if the first call takes longer than the second call to complete.

See Also

• Events Configuration Guide

• Event Definitions