Skip to main content
POST
Send a test event to a webhook subscription. **Note:** This endpoint is **only available** in the **sandbox** environment.

Overview

Note: This endpoint is available only in Sandbox environment
Sends an example event of the chosen event type to the URL of an existing subscription, so you can check that your endpoint receives and processes webhooks correctly before real events arrive.
Important: the eventType must be one of the event types the subscription was registered with. Otherwise the call fails with 422 event_type_not_in_subscription.
Important: the example is delivered and signed exactly like a real event, using the subscription’s signingSecret. Use it to validate your signature verification.
Important: the delivery is asynchronous. A 202 response means the test event was queued, not that your endpoint has already received it. The payload contains example data, so do not act on it as if it were a real event.

Authorizations

Authorization
string
header
required

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

Path Parameters

subscriptionId
string
required

The unique identifier of the webhook subscription, as returned when it was registered.

Body

application/json
eventType
enum<string>
required

The event type of the example payload to send. It must be one of the event types the subscription is registered for. See Event Models for what each one delivers.

Available options:
employee.committed-expense.created,
employee.committed-expense.finished,
employee.committed-expense.cancelled,
employee.committed-expense.payment.cancelled
Example:

"employee.committed-expense.created"

Response

The test event was accepted and queued for delivery to the subscription's URL.

messageId
string
required

The unique identifier of the queued test message.

Example:

"msg_2LKAAVHUEM1x9jdh9kJ8aT9nOzm"