Batch Publish Events

Publishes multiple events in a single request.

POST /v1/events/{projectId}/publish/batch

Batch Publish Events

cURL

curl --request POST \
  --url http://localhost:3004/v1/events/{projectId}/publish/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  {
    "eventType": "<string>",
    "payload": {},
    "targets": [
      {
        "targetId": "<string>"
      }
    ],
    "previous": {},
    "meta": {
      "priority": "normal",
      "maxRetries": 3
    }
  }
]
'

200

{
  "success": true,
  "message": "<string>",
  "data": {}
}

Publish multiple events in a single request for higher throughput.

Authorizations

x-api-key · string · header · required

Headers

Idempotency-Key · string

A unique identifier for the request to prevent duplicate processing.

Path Parameters

projectId · string · required

The unique identifier of the project.

Body

application/json

eventType · string · required

Type of event being published.

payload · object · required

The data associated with the event.

targets · object[] · required

Show child attributes

previous · object

Optional previous state of the object.

meta · object

Show child attributes

Response

200 - application/json

Events successfully queued

success · boolean

message · string

data · object