Skip to main content
POST
/
api
/
v1
/
webhooks
/
messages
Broadcast event to all endpoints
curl --request POST \
  --url https://dev-chat-engine.actualize.ae/api/v1/webhooks/messages \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-application-id: <x-application-id>' \
  --data '
{
  "eventType": "chat.ended",
  "payload": {
    "id": "some-uuid",
    "metadata": {}
  },
  "payloadRetentionPeriod": 90
}
'

Headers

​
x-api-key
string
required
​
x-application-id
string
required

Body

application/json
​
eventType
string
required

Name of the event

Example:

"chat.ended"

​
payload
object
required

Event payload

Example:
{ "id": "some-uuid", "metadata": {} }
​
payloadRetentionPeriod
number
required

Number of days to retain the payload

Required range: 1 <= x <= 90
Example:

90