Skip to main content
POST
/
v1
/
webhooks
/
{webhook_id}
/
test
Send A Test Event
curl --request POST \
  --url https://karibu.briq.tz/v1/webhooks/{webhook_id}/test \
  --header 'X-API-Key: <api-key>'
{
  "event_id": "<string>",
  "message": "<string>"
}

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string
required

Path Parameters

webhook_id
string
required

Response

Test event enqueued

Result of enqueuing a synthetic test delivery.

event_id
string
required

The event_id of the created test delivery (prefixed test_).

Example:

"test_9f8e7d6c5b4a3210"

message
string
required

Human-readable confirmation.