Events API
Fetch
GET /event/{tenantLocator}/events/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:EventResponse
Security Group:events  Permission:read
GET /event/{tenantLocator}/events/request/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:EventResponse[]
Security Group:events  Permission:read
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
¶requiredpagingToken stringevents EventResponse[]
EventResponse
¶requiredlocator locatoruserLocator uuidrequestId locator
Identifier of the transaction request that triggered the eventtimestamp datetimetype stringdata 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.