Broadcast Event

POST /v2/livestate/broadcast

Broadcast Event

cURL

curl --request POST \
  --url https://api.velt.dev/v2/livestate/broadcast \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "liveStateDataId": "<string>",
    "data": {},
    "merge": true
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Event broadcasted successfully.",
    "data": {
      "success": true
    }
  }
}

Use this API to broadcast live state events to any document. Use it with the Live State feature.

Endpoint

POST https://api.velt.dev/v2/livestate/broadcast

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body Parameters

data · object · required

Show properties

organizationId · string · required

Organization ID where the document belongs

documentId · string · required

Document ID to broadcast the event to

liveStateDataId · string · required

Unique identifier for the live state data

data · object · required

The data to broadcast. Can be any valid serializable JSON object.

merge · boolean · default: "false"

If true, merges the new data with existing data instead of replacing it

Example Request

{
  "organizationId": "YOUR_ORGANIZATION_ID",
  "documentId": "YOUR_DOCUMENT_ID",
  "liveStateDataId": "sample_live_state_data_id",
  "data": {
    "status": "active",
    "message": "Hello World",
    "customField": "custom value"
  },
  "merge": true
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Event broadcasted successfully.",
    "data": {
      "success": true
    }
  }
}

Error Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "ERROR_CODE"
  }
}

{
  "result": {
    "status": "success",
    "message": "Event broadcasted successfully.",
    "data": {
      "success": true
    }
  }
}