Real-time updates

To react to workspace changes from your own system, use webhooks. Custral posts a signed event to your endpoint when a record changes, a form is submitted, a task is completed, or a conversation is given an outcome, and the SDK verifies the signature for you. The event catalog is the complete list.

import {Custral} from "@custral/sdk";

const custral = new Custral({apiKey: process.env.CUSTRAL_API_KEY!});

custral.on("record.updated", (event) => {
  // …your logic, running on your infra
});

Custral’s own web, desktop, and mobile clients hold live socket connections for in-app presence and collaborative editing. Those transports are internal. They aren’t part of the public API, they authenticate as a signed-in user rather than with an API key, and their shape changes without notice. Webhooks are the supported way to receive changes programmatically.

Choosing between webhooks and polling

You want	Use
To be told when something changes	Webhooks
A snapshot right now	`GET /v1/records/{object}`
To catch up after downtime	List with a `sort` on the updated timestamp, then resume webhooks

Webhooks

Subscribe to events, verify signatures, and handle retries.

Requests & responses

The envelope every endpoint returns, and how to page through a list.

Introduction

Endpoints

Embeds & real-time

Choosing between webhooks and polling

See also

Webhooks

Requests & responses

​Choosing between webhooks and polling

​See also

Webhooks

Requests & responses

Choosing between webhooks and polling

See also