Skip to main content
POST
Send Test Webhook
Sends a test.event webhook to all configured webhook URLs for your client. Use this endpoint to:
  • Verify your webhook endpoint is receiving events correctly
  • Test your webhook signature verification logic
  • Validate your event processing pipeline
  • Debug webhook delivery issues
The test event will include the standard webhook structure with a test.event type.

Prerequisites

You must have at least one webhook URL configured before sending a test event. If you haven’t configured a webhook URL yet, use the Create Webhook endpoint first.

Example Request

Example Response

What Your Webhook Endpoint Will Receive

Your webhook endpoint will receive the test event with a signature header that you should verify:
The test webhook will be signed with your webhook secret key. Make sure to verify the cobalt-verification header to ensure the webhook is authentic. See Receiving Webhooks for signature verification details.

Common Use Cases

After configuring your first webhook URL, send a test event to confirm your endpoint is reachable and processing webhooks correctly.
After updating your webhook handler code, send a test event to verify your changes work as expected before going live.
If you’re not receiving production webhooks, send a test event to isolate whether the issue is with your endpoint or with specific event types.
Send a test event and verify the cobalt-verification header to ensure your signature verification logic is working correctly.

Error Responses

404 - No Webhook URLs Configured
401 - Invalid Access Token
401 - Access Token Mismatch

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Response

Test webhook sent successfully

success
boolean
Example:

true

message
string
Example:

"Test webhook sent to 2 URL(s)"

webhook_urls_count
integer
Example:

2

event
object