Skip to content

Site · Assets

Creating an Event

Last updated 18 November 2026

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

Prerequisites

  • A Site API Key (see Site API Key)
  • Basic understanding of REST APIs
  • Access to your Site API documentation at <site URL>/admin/api

Steps

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

Step 1: Get the Site API Key

To get your Site API key:

  1. Select Integrations from the main menu.
  2. Select Site API Key.
  3. Copy the Site 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 Site URL followed by with the Site API Key in the Authorization header. Copy it from Integrations > Site API Key.

For the full API endpoint reference, visit your Site API documentation at <site 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.