From 5e4a1591b66ca8161bca3da0a07ca5c77ad7351e Mon Sep 17 00:00:00 2001 From: Sudar Selva Ganesh M <117903686+ssganesh035@users.noreply.github.com> Date: Sun, 16 Feb 2025 16:02:46 +0530 Subject: [PATCH 1/3] Improved Webhook Logs Documentation with Debugging and Testing Details --- manage/webhook/log.rst | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/manage/webhook/log.rst b/manage/webhook/log.rst index 27b72ba3b..05acbd3e4 100644 --- a/manage/webhook/log.rst +++ b/manage/webhook/log.rst @@ -1,35 +1,35 @@ Webhook Logs ============ -Zammad provides a history of your recent webhooks. -You can find them below **Recent logs**. +Zammad provides a history of your recent webhook events, helping you monitor and debug interactions with third-party services. You can access them under **Recent Logs** in the webhook settings. .. figure:: /images/manage/webhook/webhook-logs-and-entries.png - :alt: Webhook logs showing possible issues with third party communication + :alt: Webhook logs showing possible issues with third-party communication :align: center :width: 90% -If you need more details you can click on the request link in question. -Zammad will provide a modal with the following information: +Each log entry contains key details about the webhook request and response, allowing you to troubleshoot delivery issues. Clicking on a request link opens a detailed modal with the following information: - Direction - Always ``out``. +Webhook Log Details +------------------- - URL - The URL Zammad sent the request to. +- **Direction**: Always ``out``, indicating outgoing requests from Zammad. +- **URL**: The destination URL where Zammad sent the request. +- **Method**: Always ``POST``. +- **Status**: The HTTP status code received from the remote server. A successful request returns a ``2xx`` code. +- **Request**: Displays the HTTP request headers and payload that Zammad sent. +- **Response**: Shows the response headers from the remote server. +- **Created at**: The timestamp when Zammad sent the request. - Method - Always ``POST``. +### Debugging Webhook Issues - Status - Contains the HTTP status code the remote server replied with. - Should be ``2xx`` if successful. +If a webhook fails (e.g., receiving a ``4xx`` or ``5xx`` status code), check the request and response details to diagnose the issue. Common causes include incorrect URLs, authentication errors, or server-side failures. - Request - Contains the request Zammad sent (HTTP header and payload) +### Testing Webhooks - Response - Contains the remotes response header. +Before deploying webhooks in production, use testing tools to inspect and debug requests: - Created at - Date and time the request was sent. +- **Beeceptor**: A free tool to capture and inspect webhook requests in real time. Set up a temporary endpoint to verify payload structure and headers. [Visit Beeceptor](https://beeceptor.com/) +- **Webhook.site**: Another useful alternative for real-time request logging and debugging. [Try Webhook.site](https://webhook.site/) + +Using these tools, you can validate your webhook configurations without affecting live systems. From 151955037cfc01908cee2a664f8d75204736a292 Mon Sep 17 00:00:00 2001 From: Sudar Selva Ganesh M <117903686+ssganesh035@users.noreply.github.com> Date: Sun, 16 Feb 2025 16:07:19 +0530 Subject: [PATCH 2/3] Fixed typo --- manage/webhook/log.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/manage/webhook/log.rst b/manage/webhook/log.rst index 05acbd3e4..2d40cb306 100644 --- a/manage/webhook/log.rst +++ b/manage/webhook/log.rst @@ -29,7 +29,6 @@ If a webhook fails (e.g., receiving a ``4xx`` or ``5xx`` status code), check the Before deploying webhooks in production, use testing tools to inspect and debug requests: -- **Beeceptor**: A free tool to capture and inspect webhook requests in real time. Set up a temporary endpoint to verify payload structure and headers. [Visit Beeceptor](https://beeceptor.com/) -- **Webhook.site**: Another useful alternative for real-time request logging and debugging. [Try Webhook.site](https://webhook.site/) +- **[Beeceptor](https://beeceptor.com/)**: A free tool to capture and inspect webhook requests in real time. Set up a temporary endpoint to verify payload structure and headers. +- **[Webhook.site](https://webhook.site/)**: Another useful alternative for real-time request logging and debugging. -Using these tools, you can validate your webhook configurations without affecting live systems. From c25574293cc60711f25843d31b337dcc7b2b95c1 Mon Sep 17 00:00:00 2001 From: Sudar Selva Ganesh M <117903686+ssganesh035@users.noreply.github.com> Date: Fri, 21 Feb 2025 16:00:32 +0530 Subject: [PATCH 3/3] Updated Webhook testing warning --- manage/webhook/log.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manage/webhook/log.rst b/manage/webhook/log.rst index 2d40cb306..4315c3892 100644 --- a/manage/webhook/log.rst +++ b/manage/webhook/log.rst @@ -27,7 +27,7 @@ If a webhook fails (e.g., receiving a ``4xx`` or ``5xx`` status code), check the ### Testing Webhooks -Before deploying webhooks in production, use testing tools to inspect and debug requests: +Before deploying webhooks in production, you can use testing tools to inspect and debug requests. If you do so, make sure to exclude any sensitive or personal data. - **[Beeceptor](https://beeceptor.com/)**: A free tool to capture and inspect webhook requests in real time. Set up a temporary endpoint to verify payload structure and headers. - **[Webhook.site](https://webhook.site/)**: Another useful alternative for real-time request logging and debugging.