Create a new web hook

Creates a new Web Hook configuration. A Web Hook allows you to register an HTTP endpoint that will receive real-time notifications when specific events occur in the platform, such as tax report, issued invoice, or ledger state changes. When creating a Web Hook, you must specify the destination URL and the events you want to subscribe to. The Web Hook will be created under the integration group associated with the API key. By default, newly created Web Hooks are enabled. When enabled, the platform will send HTTP POST requests to the configured URL whenever one of the subscribed events is triggered. Note: If you create the Web Hook with enabled=false, events may be omitted, but they will be required again when enabling the Web Hook. Use this endpoint to start receiving asynchronous notifications instead of continuously polling the API for status changes.

Body Params
web_hook
object
required
Headers
string
Defaults to 2026-03-02

Specifies the version of the API to use in this request. If not specified uses the API-Version set in the group conifguration B2Brouter UI Application -> Developers -> API Keys -> API Version

Responses

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json