¶ Testing and Troubleshooting WebHooks
¶ Introduction
After configuring WebHooks, or when experiencing issues, it can be important to test the configured WebHook Subscribers. This allows you to ensure that the configuration is correct and the endpoint is reachable while also providing a test event with real data to be processed by the configured endpoint.
For more information about the individual WebHooks and their intended use, please see WebHooks.. For instructions on configuring WebHooks, please see Configuring 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 WebHoooks for your integration.
¶ WebHook Testing
WebHooks are tested under Administration > Settings > Integration > WebHook Subscribers Test.
This allows you to test a specific WebHook Subscriber by sending real data to the configured endpoint. You will need to know the specific context of the WebHook trigger as it requires an ID, or a comma separated list of IDs, pertaining to that context. For example, if the WebHook being tested is for reps, the IDs entered would need to be RepDIDs or Rep Numbers. Simply select the WebHook Subscriber, enter the test IDs into the Primary Identifies field, and click "Process Webhook".
¶ WebHook Troubleshooting
WebHook Requests and Responses can be viewed for further troubleshooing under Administration > Tools > Web Service Log. If this menu is not available, please contact Client Support to have the menu access enabled.
This report can be used to verify that the WebHook notification was made, that the correct information was provided, and that the payload was received without issue by the 3rd-party.