curl -X POST https://api.vouchmark.com/v1/developers/webhooks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"appId": "...",
"environment": "live",
"serviceType": "kyc_widget",
"endpoint": "https://api.example.com/webhooks/vouchmark"
}'
{
"success": true,
"data": {
"id": "...",
"appId": "...",
"environment": "live",
"serviceType": "kyc_widget",
"endpoint": "https://...",
"isActive": true,
"signingSecret": "whsec_...",
"createdAt": "..."
}
}
Developers
Create webhook
Register a webhook subscription for a service.
POST
/
v1
/
developers
/
webhooks
curl -X POST https://api.vouchmark.com/v1/developers/webhooks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"appId": "...",
"environment": "live",
"serviceType": "kyc_widget",
"endpoint": "https://api.example.com/webhooks/vouchmark"
}'
{
"success": true,
"data": {
"id": "...",
"appId": "...",
"environment": "live",
"serviceType": "kyc_widget",
"endpoint": "https://...",
"isActive": true,
"signingSecret": "whsec_...",
"createdAt": "..."
}
}
Creates a webhook subscription that delivers events for one service type to your endpoint.
Returns
Body
string
required
Widget / app ID this subscription belongs to. 1–64 characters.
string
required
One of
sandbox or live.string
required
One of
kyc_widget, verification, trust_monitor, disputes.string
required
Delivery URL. Must be an
http or https URL.curl -X POST https://api.vouchmark.com/v1/developers/webhooks \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"appId": "...",
"environment": "live",
"serviceType": "kyc_widget",
"endpoint": "https://api.example.com/webhooks/vouchmark"
}'
{
"success": true,
"data": {
"id": "...",
"appId": "...",
"environment": "live",
"serviceType": "kyc_widget",
"endpoint": "https://...",
"isActive": true,
"signingSecret": "whsec_...",
"createdAt": "..."
}
}
201 Created.
The full
signingSecret is returned only on create and rotate.
Store it securely now — it cannot be retrieved later. List responses return a masked
signingSecretMasked instead. See Verifying the signature.Response fields
boolean
object
Show webhook
Show webhook
string
string
string
One of
sandbox or live.string
One of
kyc_widget, verification, trust_monitor, disputes.string
boolean
Whether the subscription is active and receiving deliveries.
string
The full signing secret (
whsec_...), returned once. Use it to verify the
X-Vouchmark-Signature header on deliveries.string