- 01 Jun 2022
- 1 Minute to read
- Print
- DarkLight
- PDF
Register Callback
- Updated on 01 Jun 2022
- 1 Minute to read
- Print
- DarkLight
- PDF
Register a Callback
Callbacks enable the system to receive automated notifications through APIs.
Click on the Business Workflows page from the Navigation Panel.
From within the Business Workflows page, locate and click on the Callbacks button in the top right corner.
Register Callback Button
- From within the Callbacks sidebar window, enter in
a. The callback name
b. The callback URL
c. Select the Business Entity from the dropdown list.
The Business Entity section will have the dropdown list enabled if the participant is a part of more than one business entity.
Configuring the Callback
- When selecting the authentication method, three options are given:
a. None – no authentication.
b. Basic Auth – Basic Authentication requiring
i. a username and
ii. a password.
Using Basic Auth Authentication
c. OAuth2 – the most secure type of authentication requiring
i. A Client ID – obtained when generating webhook credentials.
ii. A Client Secret (code) – obtained when generating webhook credentials.
iii. A Token URL.
Using OAuth2 Authentication
- After selecting the authentication type, click on the Save button to successfully register a callback.