right logo image
right logo image
Log on

API Explorer

Log off

v3.1.0 (249 APIs)

API Host: https://api.ttk.com.mk
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

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful 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
}
Required Roles:
  • CanCreateWebhook - Please login to request this Role
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.1.0 by createAccountWebhook, operation_id: OBPv3.1.0-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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful 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
}
Required Roles:
  • CanUpdateWebhook - Please login to request this Role
Possible Errors:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Implemented in OBPv3.1.0 by enableDisableAccountWebhook, operation_id: OBPv3.1.0-enableDisableAccountWebhook

Get Account Webhooks

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

  • sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

  • account_id=STRING (if null ignore)
  • user_id=STRING (if null ignore)

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful 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
  }]
}
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.
Connector Methods:
Implemented in OBPv3.1.0 by getAccountWebhooks, operation_id: OBPv3.1.0-getAccountWebhooks