Skip to main content
POST
Test webhook

Authorizations

Authorization
string
header
required

Brelio API key (organization or user) or a WorkOS access token.

Headers

Idempotency-Key
string
required

Unique per command; reuse it only to retry the same call.

Required string length: 8 - 255

Path Parameters

id
string<uuid>
required

Webhook endpoint id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

The body is of type object.

Response

Success

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
eventType
string
required
Allowed value: "webhookEndpoint.tested"