Insites Docs Instance DashboardEvent StreamCreating an Event

AI answers drawn only from these docs, with links to the pages used.

Creating an Event

Last updated on October 10, 2026.

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

Prerequisites

  • An Instance API Key (see Instance API Key)
  • Basic understanding of REST APIs
  • Access to your Instance API documentation at <instance URL>/admin/api

Steps

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

Step 1: Get the Instance API Key

To get your Instance API key:

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

Step 2: Build the Event Object

Each event requires a at minimum. The server sets the to the time of your request, so you do not send it.

Event object properties:

ParameterRequiredDescription
NoSet by the server to the time of your request (Unix epoch timestamp).
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 Instance API Key in the Authorization header. Copy it from Integrations > Instance API Key.

For the full API endpoint reference, visit your Instance API documentation at <instance URL>/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.