Skip to content
Scalekit Docs

Webhook event object

A webhook (also called a web callback or HTTP push API) is a way for Scalekit to provide your applications with real-time information. A webhook delivers data to your applications as it happens, meaning you get data immediately, unlike typical APIs where you would need to poll for data very frequently to get it in real-time. Events represent specific actions or changes, while webhooks are the mechanism used to deliver these event notifications to your specified endpoint.

By leveraging webhooks, you can build responsive and dynamic integrations that react immediately to changes in Scalekit System, enabling you to keep your systems in sync and automate user lifecycle management and other related use cases.

The webhook event object contains standardized fields that provide context about the event, along with event-specific data in the data field.

PropertyDescription
spec_version
The version of the event specification format. Currently “1”.
id
A unique identifier for the event (e.g., evt_123456789).
object
The type of object that triggered the event (e.g., “DirectoryUser”, “Directory”, “Connection”).
environment_id
The ID of the environment where the event occurred.
occurred_at
ISO 8601 timestamp indicating when the event occurred.
organization_id
The ID of the organization associated with the event.
type
The specific event type (e.g., “organization.directory.user_created”).
data
Event-specific payload containing details relevant to the event type.
Sample Event Payload
{
  "spec_version": "1",
  "id": "evt_123456789",
  "object": "DirectoryUser",
  "environment_id": "env_123456789",
  "occurred_at": "2024-08-21T10:20:17.072Z",
  "organization_id": "org_123456789",
  "type": "organization.directory.user_created",
  "data": {
    // Event Data
  }
}