A WebHook is a predefined outbound JSON API call that Freedom makes to a 3rd party. This call is used to report information changes that happen within Freedom. When using WebHooks, the 3rd party must implement an endpoint supporting the ByDesign JSON specifications. This can then be implemented through configurations in Freedom using the endpoint URL and BasicAuth credentials provided by the 3rd party.
To configure additional WebHooks, please see Configuring WebHooks. For Testing and troubleshooting, please see Testing WebHooks.
There are multiple types of WebHooks available for different triggering events. The event defines what type of information may have changed and the circumstances of that change. Each trigger defined a different JSON payload of relevant information. In most cases, each WebHook uses a different endpoint for ease of use and support.
Trigger Types