Events API

Endpoint Index

Action	Endpoint
Fetch an Event	GET /event/{tenantLocator}/events/{locator}
Fetch Events for an API Request	GET /event/{tenantLocator}/events/request/{locator}
Fetch Multiple Events	GET /event/{tenantLocator}/events/list
Fetch Scheduled Policy Events	GET /event/{tenantLocator}/events/schedules/policy/{policyLocator}
Resume Failed Scheduled Event	POST /event/{tenantLocator}/events/schedules/failed/resume
Fetch Failed Scheduled Tenant Events	GET /event/{tenantLocator}/events/schedules/tenant/failed/list
Fetch Failed Scheduled Policy Events	GET /event/{tenantLocator}/events/schedules/policy/{policyLocator}/failed/list
Fetch Failed Scheduled Events By Failed Job State	GET /event/{tenantLocator}/events/schedules/failed/{failedJobState}/list
Fetch Failed Scheduled Events	GET /event/{tenantLocator}/events/schedules/failed/list
Delete Failed Scheduled Event	DELETE /event/{tenantLocator}/events/schedules/failed

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>

Fetch Scheduled Policy Events

¶

fetchScheduledPolicyEvents

GET /event/{tenantLocator}/events/schedules/policy/{policyLocator}

Request Parameters:

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

Response:ScheduledPolicyEvent[]

Security Group:events Permission:read

ScheduledPolicyEvent

¶

required
policyLocator string
transactionLocator string
triggerState Enum BLOCKED | COMPLETE | ERROR | NONE | NORMAL | PAUSED
customEventId string

optional
nextEventTime datetime?

Resume Failed Scheduled Event

¶

resumeFailedScheduledEvent

POST /event/{tenantLocator}/events/schedules/failed/resume

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:FailedJobRequest

Response:void

Security Group:events Permission:write

Fetch Failed Scheduled Tenant Events

¶

fetchFailedScheduledTenantEvents

GET /event/{tenantLocator}/events/schedules/tenant/failed/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:FailedJobDetails[]

Security Group:events Permission:read

Fetch Failed Scheduled Policy Events

¶

fetchFailedScheduledPolicyEvents

GET /event/{tenantLocator}/events/schedules/policy/{policyLocator}/failed/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
policyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:FailedJobDetails[]

Security Group:events Permission:read

Fetch Failed Scheduled Events By Failed Job State

¶

fetchFailedScheduledEventsByFailedJobState

GET /event/{tenantLocator}/events/schedules/failed/{failedJobState}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
failedJobState	path	Enum queued \| quit	required
offset	query	int?	optional
count	query	int?	optional

Response:FailedJobDetails[]

Security Group:events Permission:read

Fetch Failed Scheduled Events

¶

fetchFailedScheduledEvents

GET /event/{tenantLocator}/events/schedules/failed/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:FailedJobDetails[]

Security Group:events Permission:read

Delete Failed Scheduled Event

¶

deleteFailedScheduledEvent

DELETE /event/{tenantLocator}/events/schedules/failed

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:FailedJobRequest

Response:void

Security Group:events Permission:write

FailedJobRequest

¶

required
triggerName string
triggerGroup string

FailedJobDetails

¶

required
triggerName string
failedJobState Enum queued | quit
failureCount int
triggerGroup string
updatedAt datetime
createdAt datetime

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.

Events API

Endpoint Index

Fetch

See Also