{"resource_docs":[{"operation_id":"OBPv4.0.0-createSystemAccountNotificationWebhook","implemented_by":{"version":"OBPv4.0.0","function":"createSystemAccountNotificationWebhook"},"request_verb":"POST","request_url":"/obp/v4.0.0/web-hooks/account/notifications/on-create-transaction","summary":"Create system level Account Notification Webhook","description":"
Create a notification Webhook that will fire for all accounts on the system.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nAuthentication is Mandatory
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","description_markdown":"Create a notification Webhook that will fire for all accounts on the system.\n\n\nWebhooks are used to call external web services when certain events happen.\n\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.\n\n\n\n\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.\n\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.\n |\nThe webhook will POST the following structure to your service:\n\n{\n \"event_name\": \"OnCreateTransaction\",\n \"event_id\": \"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"transaction_id\": \"7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"related_entities\": [\n {\n \"user_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"customer_ids\": [\"3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\"]\n }\n ]\n}\n\nThus, your service should accept the above POST body structure.\n\nIn this way, your web service can be informed about an event on an account and act accordingly.\n\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.\n\n\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**webhook_id**](/glossary#): webhook_id\n\n\n","example_request_body":{"url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1"},"success_response_body":{"webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","trigger_name":"OnCreateTransaction","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateSystemAccountNotificationWebhook","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/web-hooks/account/notifications/on-create-transaction","connector_methods":[]},{"operation_id":"OBPv3.1.0-getAccountWebhooks","implemented_by":{"version":"OBPv3.1.0","function":"getAccountWebhooks"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/banks/BANK_ID/account-web-hooks","summary":"Get Account Webhooks","description":"Get Account Webhooks.
\nPossible custom URL parameters for pagination:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n","description_markdown":"Get Account Webhooks.\n\nPossible custom URL parameters for pagination:\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n* account_id=STRING (if null ignore)\n* user_id=STRING (if null ignore)\n\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**web_hooks**](/glossary#web_hooks): \n\n\n","success_response_body":{"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}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Webhook","Bank"],"typed_success_response_body":{"type":"object","properties":{"web_hooks":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}}},"roles":[{"role":"CanGetWebhooks","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"operation_id":"OBPv3.1.0-enableDisableAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"enableDisableAccountWebhook"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Enable/Disable an Account Webhook","description":"Enable/Disable an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Enable/Disable an Account Webhook\n\n\nWebhooks are used to call external URLs when certain events happen.\n\nAccount Webhooks focus on events around accounts.\n\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.\n\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"account_webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","is_active":"true"},"success_response_body":{"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},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"account_webhook_id":{"type":"string"},"is_active":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanUpdateWebhook","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankAccountNotificationWebhook","implemented_by":{"version":"OBPv4.0.0","function":"createBankAccountNotificationWebhook"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/web-hooks/account/notifications/on-create-transaction","summary":"Create bank level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the specified Bank.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","description_markdown":"Create a notification Webhook that will fire for all accounts on the specified Bank.\n\n\nWebhooks are used to call external web services when certain events happen.\n\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.\n\n\n\n\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.\n\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.\n |\nThe webhook will POST the following structure to your service:\n\n{\n \"event_name\": \"OnCreateTransaction\",\n \"event_id\": \"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"transaction_id\": \"7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"related_entities\": [\n {\n \"user_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"customer_ids\": [\"3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\"]\n }\n ]\n}\n\nThus, your service should accept the above POST body structure.\n\nIn this way, your web service can be informed about an event on an account and act accordingly.\n\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.\n\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**webhook_id**](/glossary#): webhook_id\n\n\n","example_request_body":{"url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1"},"success_response_body":{"webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","bank_id":"gh.29.uk","trigger_name":"OnCreateTransaction","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateAccountNotificationWebhookAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/web-hooks/account/notifications/on-create-transaction","connector_methods":[]},{"operation_id":"OBPv3.1.0-createAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"createAccountWebhook"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Create an Account Webhook","description":"Create an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhttp_method: GET
\n\nis_active: true
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: true
\n\n\n","description_markdown":"Create an Account Webhook\n\nWebhooks are used to call external URLs when certain events happen.\n\nAccount Webhooks focus on events around accounts.\n\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.\n\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","is_active":"true"},"success_response_body":{"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},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"is_active":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateWebhook","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-web-hooks","connector_methods":[]}]}