Skip to main content
POST
/
events
Publish a New Event
curl --request POST \
  --url https://api.example.com/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "actor": {
    "type": "<string>",
    "id": "<string>",
    "name": "<string>"
  },
  "payload": {},
  "orgId": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "entity": "event",
    "organization_id": "<string>",
    "name": "<string>",
    "scope": "<string>",
    "source": "<string>",
    "payload": {},
    "version": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Body

application/json
type
string
required
actor
object
required
payload
object
required
orgId
string | null

Response

201 - application/json

The published event

success
boolean
data
object