Get Account Webhooks
GET /obp/v7.0.0/management/banks/BANK_ID/account-web-hooks
OBPv3.1.0-getAccountWebhooks Roles: CanGetWebhooks(per bank) WebhookBank
Get Account Webhooks.
Possible custom URL parameters for pagination:
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.
- account_id=STRING (if null ignore)
- user_id=STRING (if null ignore)
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 (10)
- 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
- web_hooks
Example success response
{
"web_hooks": [
{
"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-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.