¶ Configuring WebHooks
¶ Introduction
Once you have determined the required WebHooks for your integration, you can proceed to creating or editing the WebHook subscribers. Please note that some WebHooks can require additional configuration changes to enable them depending on the age of your Freedom installation. If you experience issues with the configured WebHooks, please email Support@ByDesign.com.
For more information about the individual WebHooks and their intended use, please see WebHooks.. If you need to test or troubleshoot your WebHooks Subscriber configurations, please see Testing WebHooks.
ByDesign does not define the required values for these configurations. These details would need to be provided by your developers or the 3rd-party when enabling WebHooks for your integration.
¶ WebHook Triggers
Webhooks are configured under Administration > Settings > Integration > WebHook Subscribers. It is supported for multiple integrations to use the same trigger or WebHook Type so long as they are configured as separate WebHook Subscribers.
You can select an existing WebHook Subscriber to edit it or Create a new Subscriber as needed. You will need to complete the basic values for the Subscriber. There are additional fields for Subscriber Reference and Http Header information that can also be entered if needed for the specific integration and WebHook Configuration type.
¶ Basic Information
- Description - Your Internal description for the specific integration and trigger combination.
- EndPoint URL - Notification destination URL as defined by the 3rd-party
- Basic Auth Username and Basic Auth Password - Username and password combination as defined by the 3rd-party.
- WebHook Configuration - Indicates the triggering event and payload used for the notification to the 3rd-party integration.
- Active - Toggles turns on and off the webhook subscriber.
¶ Optional Details
- Subscriber Reference # - optional details to help the 3rd-party further identify the context of the notification, if needed.
- Http Header Key and Http Header Value - Optional details to include for additional conext in the request header rarther than in the payload or body of the message.