Test a notification settings with mock data

POST /v5/notifications/test

Test a notification settings with mock data

cURL

curl --request POST \
  --url https://api.kadoa.com/v5/notifications/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventType": "workflow_finished",
  "workflowId": "workflow-123"
}
'

200

{
  "data": {
    "eventId": "<string>",
    "eventType": "<string>",
    "workflowId": "<string>"
  },
  "status": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication

Body

application/json

eventType · string · required

Event type to test (e.g., workflow_finished, workflow_data_change)

Example:

"workflow_finished"

workflowId · string

Optional workflow ID for workflow-specific testing

Example:

"workflow-123"

Response

200

application/json

Test event sent successfully

data · object

Show child attributes

status · string

message · string