Insites Docs Instance DashboardEvent StreamCreating an Event

Creating an Event

Last updated on March 31, 2026.

This article explains how to add events to your Instance Event Stream using the API.

Prerequisites

  • An Event Stream API Key (see Event Stream API Key)
  • Basic understanding of REST APIs
  • Access to your Instance API documentation at /admin/api

Steps

  1. Get the Event Stream API Key
  2. Build the event object
  3. Send the API request

Step 1: Get the Event Stream API Key

To get your Instance API key:

  1. Select Integrations from the main menu.
  2. Select Event Stream API Key.
  3. Copy the Event Stream API Key and set it aside.

Step 2: Build the Event Object

Each event requires a (Unix epoch timestamp) and a at minimum.

Event object properties:

ParameterRequiredDescription
YesUnix epoch timestamp of the event.
YesDescription of the event. Supports HTML.
YesInsites Font Icon to display on the timeline.
YesThe color of the icon (hex value).
Stringified JSON of additional event data.
JSON attribute containing field and value content.
UUID of the entity related to the event.
Type of the related entity.

Step 3: Send the API Request

Make a POST request to your Instance URL followed by with the Event Stream API Key in the Authorization header.

For the full API endpoint reference, visit your Instance API documentation at /admin/api.

Important: The endpoint requires the authorization key in the header. Passing the API Key as a URL parameter will result in an error.

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.