Enable/Disable an Account Webhook
PUT /obp/v7.0.0/banks/BANK_ID/account-web-hooks
OBPv3.1.0-enableDisableAccountWebhook Roles: CanUpdateWebhook(per bank) WebhookBank
Enable/Disable an Account Webhook
Webhooks are used to call external URLs when certain events happen.
Account Webhooks focus on events around accounts.
For instance, a webhook could be used to notify an external service if a balance changes on an account.
This functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields (9)
- account_id
- 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
- account_webhook_id
- bank_id
- gh.29.uk
- created_by_user_id
- http_method
- GET
- http_protocol
- is_active
- false
- trigger_name
- url
- http://www.example.com/id-docs/123/image.png
Example request body
{
"account_webhook_id": "fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762",
"is_active": "true"
}Example success response
{
"account_webhook_id": "613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"bank_id": "gh.29.uk",
"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"trigger_name": "OnBalanceChange",
"url": "https://localhost.openbankproject.com",
"http_method": "POST",
"http_protocol": "HTTP/1.1",
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"is_active": true
}Possible errors (3)
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles: