Skip to main content
POST
Test webhook

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

webhookId
string
required

Opaque identifier of the webhook.

Pattern: ^whk_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json

Request payload for testing a webhook.

Request payload for testing a webhook.

payload
any

Optional custom payload to send in the test request. If not provided, a default test payload will be used.

Response

Result of a webhook delivery attempt.

Result of a webhook delivery attempt.

responseTimeMs
integer<int64>
required

Time taken to receive a response in milliseconds.

statusCode
integer<uint16>
required

HTTP status code returned by the webhook endpoint.

Required range: 0 <= x <= 65535