Payloads

​

Introduction

When a webhook is triggered, Quartr sends a payload to the endpoint you specified. The payload contains information about the event that occurred, such as the type of event, the data that changed, and the previous state of the data. The objects are meant to reflect the models in our API, so you can easily map the payload to your internal data structures.

​

Payload structure

​

Types of events

There are three types of events you can receive:

• Created: A new entity was created.
• Updated: An existing entity was updated.
• Deleted: An entity was deleted.

​

Headers

In addition to the typical headers, Quartr includes the following headers in the webhook request:

• Webhook-Id: A unique message identifier (not user-controlled).
• Webhook-Timestamp: The time the message was generated (Unix timestamp in seconds).
• Webhook-Signature: A cryptographic signature that allows you to verify the integrity and authenticity of the payload.

​

Body

The payload is a JSON object with the following structure:

{
  "timestamp": "2025-03-18T13:17:27.000Z",
  "type": "live.audio.updated",
  "data": {
    "id": 327960,
    "eventId": 328733,
    "date": "2025-03-18T13:00:00.000Z",
    "createdAt": "2025-03-18T13:07:51",
    "updatedAt": "2025-03-18T13:17:27",
    "wentLiveAt": "2025-03-18T13:17:27",
    "state": "live",
    "audio": "https://files.quartr.com/streams/2025-03-18/1/playlists.m3u8",
    "companyId": 4122
  },
  "previousAttributes": {
    "updatedAt": "2025-03-18T13:17:26",
    "state": "willBeLive",
    "wentLiveAt": null,
    "audio": null
  }
}

The payload contains the following fields:

• timestamp: The time the event occurred.
• type: The type of event that occurred.
• data: The new state of the entity. Empty for deletes.
• previousAttributes: The partial representation of previous state of the entity.

The entity types and fields in the payload are the same as in our API. For example, the live.audio.updated event payload mirrors the Live Audio model in our API.