Skip to main content
POST
Send test webhook
Sends a test webhook event to verify configuration. Useful for testing webhook endpoint and HMAC signature verification.

Permissions

Only OWNERS and ADMINS can test webhooks.

Path Parameters

Example Request

Response

Returns 202 Accepted on success. The test webhook is queued for delivery.

Testing Your Webhook

  1. Send test request using this endpoint
  2. Check delivery history using /webhooks/{id}/deliveries
  3. Verify HMAC signature in the webhook payload
  4. Confirm event structure matches your expectations

Test Event Structure

The test webhook will include:
  • Event type: webhook.test
  • Webhook metadata
  • HMAC signature header
  • Timestamp and event ID

Common Errors

401 Unauthorized

Authentication required.

403 Forbidden

Only owners and admins can test webhooks.

404 Not Found

Webhook not found with the provided ID.

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required
id
string
required

Response

Test webhook queued for delivery. Check delivery history to see results.