Insites Docs Instance DashboardEvent StreamCreating an Event

Creating an Event

Last updated on August 31, 2024.

This article provides a detailed explanation of the process involved in adding events to your Instance's Event Stream using an API endpoint.

Prerequisites

To be able to follow this tutorial, you must have a firm grasp of how APIs work. In addition, it is helpful to have a certain level of familiarity with the Insites API documentation.

Steps

Adding an event to your Instance's Event Stream can be summarized in the following steps:

  • Step 1: Get the Event Stream API key
  • Step 2: Build the event object
  • Step 3: Add the event

Step 1: Get the Event Stream API key

To get your Instance's API keys:

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

Step 2: Build the event object

Displayed below is a sample code snippet for the object:

A table of the object's properties and input requirements are displayed below:

Parameter RequiredDescription
Universally Unique Identifier (UUID) of the entity related to the event stream record.
YesInsites Font Icon you want to display on your Events timeline.
YesThe color of the icon.
YesMarkdown description of the event.

This is the stringified version of the response results from the previous API call.

JSON attribute that contains the field and value content of the details.

The module the event is related to.

The feature of the module that the event relates to.

Step 3: Add the event

Make an API request to create an event in the event stream:

  1. Take the Event Stream API Key you set aside in Step 1 and include it in your request header.
  2. Send an API call to the endpoint URL with a method of .
Note

Please visit our API documentation should you want to learn more about the Insites API or perform tests on the endpoints: Creating an Event

Important

The endpoint needs the authorization key in the header for it to be authorized; attempting to pass the Event Stream API Key as a parameter via URL 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.