This article explains how to set up and manage WebHooks to automate notifications and integrations when feedback events occur in your system.
Overview
A WebHook is a method for sending real-time notifications to a specified URL when specific events occur, such as feedback creation, updates, or publishing. This feature allows seamless integration with your systems and ensures you stay informed of key feedback events.
WebHooks Dashboard
The WebHooks dashboard includes the following features:
Pre-Shared Key
A unique security key shared between your system and the WebHook endpoint. This ensures secure communication and validates requests.
Configured WebHooks
View all registered WebHooks, including:
- Rule Name
- Event Triggers
- WebHook URL
How to Register a WebHook
Follow these steps to set up a new WebHook:
1. Set Rule Name
Provide a descriptive name for the WebHook rule (e.g., "Feedback Notifications").
2. Choose Event Triggers
Select the events that will trigger the WebHook:
- Feedback Created: Notify when new feedback is submitted.
- Feedback Updated: Notify when existing feedback is modified.
- Feedback Published: Notify when feedback is published or made visible.
3. Enter WebHook URL
Specify the URL where notifications will be sent. Ensure the endpoint is configured to handle incoming requests.
Best Practices
- Secure Your WebHook URL: Use HTTPS for secure communication and validate incoming requests with the pre-shared key.
- Handle Payloads: Ensure your endpoint can process the data payload sent by the WebHook. This may include feedback details such as dates, descriptions, and user information.
- Test Your WebHook: Test the integration after setup to confirm the notifications are received and processed correctly.
For further assistance with WebHooks, contact our support team or refer to additional developer resources in the Knowledge Base.