API Explorer

OBP v3.1.0 filtered by tag: Webhook (3 APIs)

Bank

Accounts

Views

Counterparties

Transactions

Create an Account Webhook

Create 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

Typical Successful Response:

								
									
{ "account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "bank_id":"obp-x", "account_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762", "trigger_name":"OnBalanceChange", "url":"https://localhost.openbankproject.com", "http_method":"POST", "http_protocol":"HTTP/1.1", "created_by_user_id":"b1fd9b29-659d-4838-a300-ea65b65b5fb6", "is_active":true }
Headers:

								
									
Required Roles:
  • CanCreateWebhook - Please login to request this Role
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createAccountWebhook

Enable/Disable an Account Webhook

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

Typical Successful Response:

								
									
{ "account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "bank_id":"obp-x", "account_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762", "trigger_name":"OnBalanceChange", "url":"https://localhost.openbankproject.com", "http_method":"POST", "http_protocol":"HTTP/1.1", "created_by_user_id":"b1fd9b29-659d-4838-a300-ea65b65b5fb6", "is_active":true }
Headers:

								
									
Required Roles:
  • CanUpdateWebhook - Please login to request this Role
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by enableDisableAccountWebhook

Get Account Webhooks

Get Account Webhooks.

Possible custom URL parameters for pagination:

  • limit=NUMBER
  • offset=NUMBER
  • account_id=STRING
  • user_id=STRING
Typical Successful Response:

								
									
{ "web_hooks":[{ "account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f", "bank_id":"obp-x", "account_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762", "trigger_name":"OnBalanceChange", "url":"https://localhost.openbankproject.com", "http_method":"POST", "http_protocol":"HTTP/1.1", "created_by_user_id":"b1fd9b29-659d-4838-a300-ea65b65b5fb6", "is_active":true }] }
Headers:

								
									
Required Roles:
  • CanGetWebhooks - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getAccountWebhooks