Ping Webhook

Send a test event to your webhook url

POST /webhooks/:webhookId/ping

This endpoint is meant for webhook setup and troubleshooting. Calling the endpoint will trigger a fake test event that will be pushed to the webhook url. The fake event will not be saved and not appear in further requests to Webhook Events.

• User action signature required. See User Action Signing for more information.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

Permissions Required

• Webhooks:Ping

Request Body

{}

Response

{
  "status": "500",
  "error": "Internal Server Serror", // optional, may not be there if status is "200"
}

Property	Type	Description
status	String	Resulting status of the webhook request when test event was pushed to it. Can be a http status code (eg "200" or "500") if your server responded, or another error code otherwise. This can be helpful to troubleshoot your webhook endpoint.
error	String - Optional	Will show an error message if status was not "200"