Events API

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}
Fetch Scheduled Tenant Events	GET/event/{tenantLocator}/events/schedules/tenant
Schedule Custom Tenant Events	POST/config/{tenantLocator}/tenantEvents
Resume Failed Scheduled Event	POST/event/{tenantLocator}/events/schedules/failed/resume
Fetch Failed Scheduled Policy Events	GET/event/{tenantLocator}/events/schedules/policy/{policyLocator}/failed/list
Fetch Failed Scheduled Tenant Events	GET/event/{tenantLocator}/events/schedules/tenant/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

Fetch an EventfetchEvent

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:EventResponse

Security Group:events

Permission:

read

Fetch Events for an API Request

Fetch Events for an API RequestfetchEventsForARequest

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:EventResponse[]

Security Group:events

Permission:

read

Fetch Multiple Events

Fetch Multiple EventsfetchMultipleEvents

GET/event/{tenantLocator}/events/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`startTimestamp`	query	`datetime?`	No
`endTimestamp`	query	`datetime?`	No
`type`	query	`string?`	No
`pageSize`	query	`integer?`	No
`pagingToken`	query	`string?`	No

Response:EventStreamResponse

Security Group:events

Permissions:

read,list

EventStreamResponse

Required properties

Property	Type	Description
`pagingToken`	`string`
`events`	`EventResponse[]`

EventResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`userLocator`	`uuid`
`requestId`	`ulid`	Identifier of the transaction request that triggered the event
`timestamp`	`datetime`
`type`	`string`
`data`	`map<string, object>`

Fetch Scheduled Policy Events

Fetch Scheduled Policy EventsfetchScheduledPolicyEvents

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes

Response:ScheduledPolicyEvent[]

Security Group:events

Permission:

read

ScheduledPolicyEvent

Required properties

Property	Type	Description
`policyLocator`	`ulid`
`transactionLocator`	`ulid`
`triggerState`	`Enum NONE \| NORMAL \| PAUSED \| COMPLETE \| ERROR \| BLOCKED`
`customEventId`	`string`

Optional properties

Property	Type	Description
`nextEventTime`	`datetime?`

Fetch Scheduled Tenant Events

Fetch Scheduled Tenant EventsfetchScheduledTenantEvents

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Response:ScheduledTenantEvent[]

Security Group:events

Permission:

read

ScheduledTenantEvent

Required properties

Property	Type	Description
`triggerState`	`Enum NONE \| NORMAL \| PAUSED \| COMPLETE \| ERROR \| BLOCKED`
`customEventId`	`string`
`scheduledEventId`	`string`

Optional properties

Property	Type	Description
`nextEventTime`	`datetime?`

Schedule Custom Tenant Events

Schedule Custom Tenant EventsscheduleTenantEvents

POST/config/{tenantLocator}/tenantEvents

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:ScheduleTenantEventsRequest

Response:void

Security Group:tenantEvents

Permission:

tenant-events

ScheduleTenantEventsRequest

Required properties

Property	Type	Description
`requests`	`ScheduleTenantEventRequest[]`

ScheduleTenantEventRequest

Required properties

Property	Type	Description
`eventTime`	`datetime`
`eventTypeId`	`string`
`scheduleId`	`string`
`data`	`map<string, object>`

Resume Failed Scheduled Event

Resume Failed Scheduled EventresumeFailedScheduledEvent

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:FailedJobRequest

Response:void

Security Group:events

Permission:

write

Fetch Failed Scheduled Policy Events

Fetch Failed Scheduled Policy EventsfetchFailedScheduledPolicyEvents

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:FailedJobDetails[]

Security Group:events

Permission:

read

Fetch Failed Scheduled Tenant Events

Fetch Failed Scheduled Tenant EventsfetchFailedScheduledTenantEvents

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:FailedJobDetails[]

Security Group:events

Permission:

read

Fetch Failed Scheduled Events By Failed Job State

Fetch Failed Scheduled Events By Failed Job StatefetchFailedScheduledEventsByFailedJobState

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`failedJobState`	path	`Enum queued \| quit`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:FailedJobDetails[]

Security Group:events

Permission:

read

Fetch Failed Scheduled Events

Fetch Failed Scheduled EventsfetchFailedScheduledEvents

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:FailedJobDetails[]

Security Group:events

Permission:

read

Delete Failed Scheduled Event

Delete Failed Scheduled EventdeleteFailedScheduledEvent

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:FailedJobRequest

Response:void

Security Group:events

Permission:

write

FailedJobRequest

Required properties

Property	Type	Description
`triggerName`	`string`
`triggerGroup`	`string`

FailedJobDetails

Required properties

Property	Type	Description
`triggerName`	`string`
`failedJobState`	`Enum queued \| quit`
`failureCount`	`integer`
`triggerGroup`	`string`
`updatedAt`	`datetime`
`createdAt`	`datetime`

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

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

Fetch

Fetch an Event

Fetch Events for an API Request

Fetch Multiple Events

Fetch Scheduled Policy Events

Fetch Scheduled Tenant Events

Schedule Custom Tenant Events

Resume Failed Scheduled Event

Fetch Failed Scheduled Policy Events

Fetch Failed Scheduled Tenant Events

Fetch Failed Scheduled Events By Failed Job State

Fetch Failed Scheduled Events

Delete Failed Scheduled Event

See Also

On this page