Skip to main content
POST
/
v1
/
events
/
{projectId}
/
publish
Publish Event
curl --request POST \
  --url http://localhost:3004/v1/events/{projectId}/publish \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventType": "<string>",
  "payload": {},
  "targets": [
    {
      "targetId": "<string>"
    }
  ],
  "previous": {},
  "meta": {
    "priority": "normal",
    "maxRetries": 3
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {}
}
Publish a single event to your project. Kyrazo will process the event and delivery it to all matching targets.

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
​
previous
object

Optional previous state of the object.

​
meta
object

Response

Event successfully queued

​
success
boolean
​
message
string
​
data
object