From 4d3dcc98f47ecd1e8695ee96c7a79ca064705b04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marko=20Mili=C4=87?= Date: Wed, 26 Dec 2018 11:38:03 +0100 Subject: [PATCH] Webhooks support #985 - updated the readme file --- README.md | 11 +++++++++++ src/main/scala/code/api/v3_1_0/APIMethods310.scala | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 15bdf1073..0fcaf9c22 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/main/scala/code/api/v3_1_0/APIMethods310.scala b/src/main/scala/code/api/v3_1_0/APIMethods310.scala index ba92c22d1..81ffc59b6 100644 --- a/src/main/scala/code/api/v3_1_0/APIMethods310.scala +++ b/src/main/scala/code/api/v3_1_0/APIMethods310.scala @@ -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