System events

List the base system events defined on your instance, or retrieve one by its id.

System events are the built-in events that workflows and custom events build on. You can list them and retrieve one. This area has 2 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List system events	GET	/settings/system_events	Lists the base system events, one page at a time.
Retrieve a system event	GET	/settings/system_events/{system_event_id}	Retrieves one system event by its evt_ id.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• System events are read only. They are the base events the platform defines; there are no writes in this area.
• System event ids start with evt_. A custom event’s base_event takes an se_ id instead, so a listed id here is not accepted there.
• One system event comes back under system_event. A listing puts its records under data.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.