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 require an Event Stream API Key in the Authorization header. You can retrieve this key from Integrations > Event Stream API Key in your Instance Admin.

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 containing at minimum a (Unix epoch timestamp) and a (text or HTML string).

Optional fields include , , , , , and .

For the complete field reference and example requests, see your Instance API documentation at /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