OPEN BANKING DOCSRegister webhook
Register a new webhook endpoint for receiving notifications
X-API-Key<token>
In: header
Header Parameters
X-API-Keystring
API key for the application
X-App-Idstring
UUID of the application
Format
uuidurlstring
Webhook endpoint URL
Format
urieventTypesarray<string>
List of event types to subscribe to
secretstring
Secret key for webhook signature verification
description?string | null
Optional description for the webhook
isActive?boolean
Whether the webhook is active
Default
trueretryPolicy?object
Retry policy for failed webhook deliveries
Response Body
curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/webhooks/register" \ -H "X-API-Key: string" \ -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com", "eventTypes": [ "TRANSACTION_COMPLETED" ], "secret": "string" }'{
"data": {
"webhookId": "string",
"url": "http://example.com",
"eventTypes": [
"string"
],
"status": "ACTIVE",
"createdAt": "2019-08-24T14:15:22Z",
"lastTriggered": "2019-08-24T14:15:22Z",
"totalDeliveries": 0,
"successfulDeliveries": 0,
"failedDeliveries": 0
}
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}