Skip to content

Send a synthetic test delivery synchronously

POST
/api/v1/webhooks/{webhook_id}/test
webhook_id
required
Webhook Id
string format: uuid

Successful Response

WebhookTestResponse

Response body for POST /api/v1/webhooks/{id}/test.

object
success
required
Success

True when the endpoint returned a 2xx response.

boolean
response_status
Any of:
integer
response_body
Any of:
string
error_message
Any of:
string
duration_ms
required
Duration Ms

Elapsed time in milliseconds.

number

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object