Event Stream API Overview

The Event Stream provides a REST API for creating and retrieving events on your Instance. This section covers the key concepts for working with the Event Stream API as a developer.

Authentication

All Event Stream API requests need your Instance API Key in the Authorization header, with no Bearer prefix. You can find this key in your Instance Admin under Integrations > Instance API Key. The instance uses its own Event Stream API Key to pass your request on, so you do not send that key.

Include the key in the Authorization header of every request:

Base Endpoint

The Event Stream API is available at:

This endpoint supports both POST (create events) and GET (retrieve events) methods.

Writing Events

Send a POST request to the events endpoint with a JSON body that contains at least a (text or HTML). The instance sets to the time it receives the request, and replaces any datetime you send.

Optional fields include , , , , , and .

For the complete field reference and example requests, see your Instance API documentation at <instance URL>/admin/api.

Reading Events

Send a GET request to the events endpoint with query parameters to filter and paginate results:

Use Cases

• Log external system events (e.g. payment received, email sent, webhook triggered)
• Track user activity from your front-end application
• Build custom dashboards by reading events from the API
• Integrate with third-party systems that consume event data

Further Reading

• Creating an Event - Step-by-step guide for writing events
• Event Stream API Key - Managing your API key
• Event Stream Introduction - Overview of the Event Stream feature