Skip to main content
POST
Test Webhook
Sends a test ping event to verify webhook connectivity and signature validation.

Overview

Use this endpoint to verify that your webhook endpoint is correctly configured and can receive and validate webhook payloads. The test sends a ping event to your endpoint.
The webhook must be subscribed to the ping event for testing to work.

Authentication

Authorization
string
required
Bearer token with write:webhooks scope

Path Parameters

id
string
required
The webhook configuration ID (UUID v4)

Response

success
boolean
Whether the test was successful
deliveryId
string
Unique delivery ID for tracking (only on success)
httpStatus
number
HTTP status code returned by your endpoint (only on success)
durationMs
number
Request duration in milliseconds (only on success)
message
string
Human-readable result message

Example Request

Example Responses

Successful Test

Failed Test

Missing Ping Event Subscription

Webhook Disabled

Test Payload

Your endpoint will receive this payload during testing:

Verifying Signature in Test

Use the test to verify your signature validation is working correctly:

Troubleshooting

  • Ensure your endpoint is publicly accessible
  • Check if your firewall allows incoming connections
  • Verify your endpoint responds within 30 seconds
  • Verify the webhook URL is correct
  • Check if your server is running
  • Ensure the port is open and accessible
  • Check your custom Authorization header value
  • Verify your endpoint’s authentication logic
  • Ensure signature verification is working correctly
Add the ping event to your webhook:

Webhooks Guide

Learn about signature verification

Update Webhook

Add ping event subscription