When the Subscribed Events add-on is enabled, up to 7 days of trackable changes ("events") are recorded for an account. For a list of all the event types tracked by Subscribed Events, please see the Knowledge Base. Note that only Account Administrators can request to enable the Subscribed Event add-on.
Some actions performed in Kantata OX can generate multiple events. For instance, approving an Expense Report will generate expense_report:updated
and expense:updated
events. Note that events for the same action are not guaranteed to appear in the exact order the changes were completed.
Also note that although we try to create events within a few minutes of an action being performed, events may take some time to appear.
Additionally, events may sometimes be duplicated. Your application should handle duplicate events appropriately.
Returns up to 7 days of records for all event types, unless filter parameters have been applied.
Only records associated with the requester's Kantata OX account are returned.
This endpoint returns structured Subscribed Event objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the subscribed_events
top-level JSON key.
Please see our Response Format section for more information.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "subscribed_events": {
- "property1": {
- "account_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "current_payload": "string",
- "event_type": "string",
- "payload_changes": "string",
- "previous_payload": "string",
- "subject_changed_at": "2019-08-24T14:15:22Z",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "user_id": 0
}, - "property2": {
- "account_id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "current_payload": "string",
- "event_type": "string",
- "payload_changes": "string",
- "previous_payload": "string",
- "subject_changed_at": "2019-08-24T14:15:22Z",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "user_id": 0
}
}
}