Skip to main content
POST
cURL

What this endpoint is for

Use this endpoint to check your webhook URL without a real booking. Novacal sends a sample payload to your URL at once and tells you the result.

The sample payload

The payload has the same shape and the same headers as a real delivery. It is signed with your webhook secret, so you can also test your signature check. The payload has "test": true and uses sample data, for example Sample Meeting and alex@example.com. Use the test field to ignore test deliveries in your own system. By default, the event is event.created. Send event in the body to test a different event, for example event.canceled.

The result

A failed test still returns 200. Check delivered to see the result.

Limits

  • A test is sent one time. There are no retries.
  • A test also works for a webhook that is not active.
  • You can only test webhooks on your own account. Another account’s webhook returns 403 access_denied.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

ID of the webhook to test

Body

application/json

Event to send. If you do not send it, event.created is used.

event
enum<string>

The event name to put in the sample payload

Available options:
event.created,
event.rescheduled,
event.canceled,
event.started,
event.ended

Response

200 - application/json

The result of the test delivery. A failed delivery also returns 200, with delivered set to false.

success
boolean
data
object