Skip to main content
POST
Test webhook endpoint

Authorizations

Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Path Parameters

webhook_config_id
string<uuid>
required

Webhook configuration ID

Response

Test result with response status and timing

Response for testing a webhook endpoint (POST /v1/webhooks/{id}/test).

Sends a test payload to the webhook URL and reports the result. A test is considered successful if the endpoint returns a 2xx status code.

success
boolean
required

Whether the test was successful (2xx response)

webhook_config_id
string<uuid>
required

Unique webhook configuration identifier

url
string
required

The webhook URL that was tested

tested_at
string<date-time>
required

Timestamp when the test was performed (ISO 8601)

response_status
integer | null

HTTP status code from webhook endpoint

response_time_ms
number | null

Response time in milliseconds

response_body
string | null

Response body preview (first 500 chars)

error_message
string | null

Error message if request failed