Broadcast Event

curl --request POST \
  --url https://api.velt.dev/v2/livestate/broadcast \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <api-key>' \
  --header 'x-velt-auth-token: <api-key>' \
  --data '{
  "data": {
    "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
  }
}'

{
  "result": {
    "status": "success",
    "message": "Operation completed successfully",
    "data": {}
  }
}

Livestate

Broadcast Event

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

Key Points:

Broadcast real-time state changes and events to all connected users
Can be any valid serializable JSON object
merge: If true, merges the new data with existing data instead of replacing it (default: false)

Use Cases:

Sync application state across users
Broadcast custom events
Share real-time data updates

📚 Full Documentation: https://docs.velt.dev/api-reference/rest-apis/v2/livestate/broadcast-event

POST

livestate

broadcast

Broadcast Event

curl --request POST \
  --url https://api.velt.dev/v2/livestate/broadcast \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <api-key>' \
  --header 'x-velt-auth-token: <api-key>' \
  --data '{
  "data": {
    "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
  }
}'

{
  "result": {
    "status": "success",
    "message": "Operation completed successfully",
    "data": {}
  }
}

Authorizations

x-velt-api-key

string

header

required

Your API key from the Velt Console

x-velt-auth-token

string

header

required

Your Auth Token for authentication

Body

application/json

data

object

required

Show child attributes

Response

Event broadcasted successfully

result

object

Show child attributes

Delete Domains Get All User Data (GDPR)

⌘I

REST APIs

SDK

Broadcast Event

Authorizations

Body

Response