Webhook Logs
Webhook Logs
Webhook logs are currently only available for context variable webhooks.
Because of the nature of the HTTP requests (which what the requests are based on), there is no way to notify the end system (your system) if the webhook call failed. Webhook logs provide you with the information needed to help you troubleshoot any issues your webhook calls might have encountered.
How the logs are generated:
Each log is related to the calls that went wrong on your webhook's answer.
We will only log wrong or faulty answers and you will not see any information when the request was returning correct data. If the logic behind the answer is different than expected, the logs will not provide you with this information and you will need to investigate further.
The logs are related to the engine requests via the correlationID, which is shared and will always be unique.
Webhook Log Settings
The webhook log data retention period settings determine the maximum number of days webhook error logs are kept across Conversational AI Cloud. The default value for this setting 7 days.
You can adjust the retention period using the slider with the value between 1 and 7 days. If you reduce the number of days, please note that this will not automatically clear the logs for previous days.
You can also delete all context variable webhook logs for your project. Once you click "Delete", you will need to confirm this action and your request will be queued.
Logs will be permanently deleted within 24 hours, and it is not possible to recover them.
Be sure to click the “Update settings” button at the bottom of the settings page to save your changes:
How to View Webhook Logs
Follow these steps to view your context variable webhook logs:
Go to the Webhook configuration screen in Conversational AI Cloud CMS
Click on the context variable webhook that you would like to view the logs for. The menu will expand and you will see a button that will take you to the screen for each environment
Select the log you want to view
The Webhook log screen will open for the environment you selected. Here you can select the date for which you would like to view the logs. The Webhook log data retention period can be between 1-7 days depending on what the project Admin has set this value to.
You can retrieve the webhooks on the Webhook log screen by clicking on the download button at the top of the screen as shown in the image above.
You can also use the APM endpoint that we expose so that you can get logs on demand.
More information on this can be found in our swagger documentation for which you will need to authenticate using our MS OAuth2 Authentication Provider.
