Copy for LLM ▼

Copy Page Content Open in ChatGPT Open in Claude Open in VS Code View Markdown

PDF

Webhooks API Event Reference Overview

When you create a webhook subscription, you specify the event types for which you want to receive notifications.

When a webhook is triggered, your configured endpoint will receive an HTTP POST request with a JSON payload containing details about the event that occurred.

The structure of the JSON payload will vary depending on the event type, but it will always include these fields:

{
    "type": "security.login.failed",
    "schema_version": "1",
    "timestamp": "2026-01-15T10:30:00Z",
    "company_uid": "your-company-uuid",
    "data": {
    // event-specific fields
}
}

The fields in the JSON payload are described below:

Field	Description
type	The event code identifying what happened
schema_version	Payload schema version (currently “1”)
timestamp	ISO 8601 timestamp of when the event occurred
company_uid	The company UUID that the event relates to
data	Event-specific payload — structure varies by event type

Event-specific data

For more details about the event-specific fields included in the data object for each event type, see the following:

• Billing Events
• Maintenance Events
• Order Events
• Outage Events
• Payment Events
• Security Events
• Service Events
• User Events

Managing webhooks using the API

To manage your webhooks programmatically, you can use the Webhooks API to create, update, and delete webhook subscriptions, list webhooks, and list available event types.