Insites Docs Instance DashboardEvent StreamEvent Stream Introduction

Event Stream Introduction

Last updated on August 08, 2024.

overview of event stream

The Event Stream is an essential feature for staying on top of your application's activity. It provides a clear timeline of events, making it easy to monitor admin actions and even create your own custom events to keep track of user interactions that matter most to you.

By integrating events from your application into the timeline, the Event Stream offers a comprehensive view of your application's ecosystem, capturing everything from internal system processes to external influences, form submissions, and secure zone logins. This consolidated, searchable, filterable, and actionable stream keeps you in the loop at all times.

With the Event Stream, you can bring background system actions and user actions into the forefront, allowing you to create custom workflows and stay informed about all the crucial events in your application.

This powerful tool allows you to view a constant stream of events in the timeline, customize the colors and icons for different events, and provide detailed information for further actions, all with full markdown support.

Please refer to the API Documentation for valuable insights into integrating your own events or retrieving events to streamline your workflow.

Features

  • Timeline view of events
  • Create events from any source via API
  • Customisable colours and icons
  • Ability to embed the timeline in your project
  • Searchable and filterable

Schema

The table below displays the fields used by the Event Stream schema.

Field NameTypeRequiredDescription
String ID of the event.
DateTime Date and time of event execution.
String Icon of the event timeline item.
String Describes the event. Can contain HTML.
String Colour of the event's timeline item icon.
String Type of the event. The following types are available by default:
  • Call
  • Chat
  • Email
  • Event
  • File Note
  • Meeting
  • SMS
  • Task Creation
  • Task Completed
  • Other
Text Provides details of the event. Usually displays the event data's JSON code.
String ID of the user who created the event or activity.
String Category of the event.
String Additional information about the event.
Array IDs related to the event (Ex. User, Event IDs, etc.).
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.