OPEN BANKING DOCSList webhooks
Retrieve all registered webhooks for the application
X-API-Key<token>
In: header
Query Parameters
status?string
Filter by webhook status
Value in
"ACTIVE" | "INACTIVE" | "SUSPENDED"eventType?string
Filter by event type
Value in
"TRANSACTION_COMPLETED" | "TRANSACTION_FAILED" | "ACCOUNT_CREATED" | "KYC_VERIFIED" | "PAYMENT_RECEIVED"Header Parameters
X-API-Keystring
API key for the application
X-App-Idstring
UUID of the application
Format
uuidResponse Body
curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/webhooks?status=ACTIVE&eventType=TRANSACTION_COMPLETED" \ -H "X-API-Key: string" \ -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"webhooks": [
{
"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
}
],
"totalCount": 0,
"activeCount": 0,
"inactiveCount": 0
}
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "2019-08-24T14:15:22Z"
}