Skip to main content
Version: v1

Get Sample Data

Gets sample data

Path Parameters
    event_name string required
Query Parameters
    subcategory string optional
    version int64 optional

A successful response.

"event_name": "string",
"version": 0,
"data": {}

You can also check this in the UI

This is a quick way to test the configuration of your endpoint, either when adding a new endpoint or when modifying an existing endpoint in the webhooks section of the settings.

Webhooks Test Endpoint

Once you've entered a destination URL and a secret, you can click on the Test Endpoint button to send a test event. A webhook event of type test will be sent to the provided destination URL, and will contain a signature header (like other events) which is generated from the provided secret.

At the end of the test, a popup window will show the result of the test; whether the response from the destination was considered a Success or a Failure. If applicable, it will also show the HTTP response code received from the destination. Please refer to the Errors and Retries section in the Getting Started page for more information on what responses are considered a Success.

Webhooks Test Endpoint Success

Event API Name


Example Payload

"eventName": "test",
"version": 1,
"data": {
"target": "",
"initiatedBy": "",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
"pirateQuote": "Run a shot across the bow!"