artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 13:07:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Webhooks support #985 - updated the readme file

Browse Source
This commit is contained in:
Marko Milić 2018-12-26 11:38:03 +01:00
parent 339cbc8250
commit 4d3dcc98f4
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -531,6 +531,17 @@ Info about rate limiting availibility at some instance can be found over next AP
}
}
```
## Webhooks
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!
There are 3 API's endpoint related to webhooks:
1. `POST ../banks/BANK_ID/account-web-hooks` - Create an Account Webhook
2. `PUT ../banks/BANK_ID/account-web-hooks` - Enable/Disable an Account Webhook
3. `GET ../management/banks/BANK_ID/account-web-hooks` - Get Account Webhooks
## Scala / Lift

4
src/main/scala/code/api/v3_1_0/APIMethods310.scala
View File

@ -899,8 +899,8 @@ trait APIMethods310 {
nameOf(enableDisableAccountWebhook),
"PUT",
"/banks/BANK_ID/account-web-hooks",
"Update an Account Webhook",
s"""Update an Account Webhook
"Enable/Disable an Account Webhook",
s"""Enable/Disable an Account Webhook
|
|
|$accountWebHookInfo