Schema Reference

Livespace Webhooks send a JSON payload in the request body. Each Webhook shares a common metadata structure, while the data field contains event-specific information.

General payload structure

{
  "version": "1.0",
  "name": "trigger.name",
  "id": "webhook-uuid",
  "timestamp": "2024-01-08T07:50:00Z",
  "webhook_delivery_attempt": 1,
  "data": {
    "id": "object-uuid"
  }
}

Common fields

Field	Type	Description
version	string	The version of the data structure, following Semantic Versioning.
name	string	The name of the event Trigger (e.g., deal.created).
id	string	A unique UUID for this specific Webhook.
timestamp	string	RFC 3339 timestamp of when the event occurred.
webhook_delivery_attempt	integer	The number of times this Webhook has been attempted (starts at 1).
data	object	The event-specific data (e.g., the Deal object).

Event-specific payloads

Detailed documentation and OpenAPI specifications for each supported Trigger:

• Deals