Send a test event

Check your handler with a test event.

Use this endpoint to send a test event to a webhook endpoint, so you can check that your handler receives it and verifies its signature. The call returns as soon as the event is queued, and the event arrives like any other, with the usual envelope:

{
  "version": "1",
  "id": "abcdef-...",
  "companyId": 10011,
  "type": "test-event.created",
  "timestamp": 17200110020,
  "data": {
    "object": {
      "testMessage": "This is a test message"
    }
  }
}

The endpoint must be enabled.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No active endpoint with this ID belongs to your company.
409The endpoint is disabled. Enable it first.
📘

Part of the Webhook Endpoints API. Authenticate with your company API key, as for every company endpoint: see Authentication & API tokens.

Path Params
integer
required

The endpoint's ID.

Responses
202

The test event is queued.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json