Sign in
Webhooks API

Test a webhook

Sends a test event to the webhook to verify the endpoint is working as expected.

post/v2/webhooks/{webhookId}/ping

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

testmodeboolean

You can enable test mode by setting testmode to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

Accepted.

Changes

Changed in 2 of the 78 revisions of this API.3

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 78 revisions, 9 have no diff computed.