Webhooks are event-driven HTTP POST requests sent to a URL you configure. Whenever a registered event occurs, WebEngage sends the event data immediately, allowing your systems to respond in real time.
Each request includes:
A unique request ID for idempotency.
Parameters such as the event type and your WebEngage license code.
A secret key to verify that the request originates from WebEngage.
A request body containing event-specific data in JSON or XML format, depending on the webhook type.
Responses with HTTP status 200 are considered successful, while other responses are logged as failed and can be retried based on your server logic.
WebEngage appends a secret key to the POST request for verification. The secret is an MD5 hash of your license code and Webhook Secret Key, which can be found in Data Platform → Integrations → Webhooks. This ensures requests are genuine and secure.
Feedback Webhook – Triggers on feedback submission.
Feedback Reply Webhook – Triggers when a reply is posted to an existing feedback thread.
Survey Response Webhook – Triggers on survey submissions.
Events Webhook – Triggered by specific custom events you register.
Activity Events Webhook – Track selected custom or campaign events. Only one event per configuration.
Global System Events Webhook – Captures campaign events such as email opens, clicks, and push notification impressions. Some system events like app installs, upgrades, crashes, or logins/logouts cannot be tracked.
Global Application Events Webhook – Pushes all custom events from website, app, or API to third-party tools.
Journey Webhook – Triggers when a journey is created, updated, published, or deleted.
Navigate to Data Platform → Integrations → Webhooks in your WebEngage dashboard.
Select the webhook type you want to configure.
Specify the event name (if applicable) and the postURL where the webhook should send data.
Choose the response format (JSON or XML where supported).
Click Save to activate the webhook.
Automatically credit customer accounts when specific events occur.
Sync real-time data with CRMs like Salesforce.
Trigger internal backend processes based on custom or campaign events.
Track and analyze campaign engagement, such as email opens, clicks, and push notification interactions.
Automate responses for journey events, including activation, updates, or deletions.
Only one event can be added per activity-specific webhook configuration.
JSON is the default format for most event-based webhooks.
Unique request IDs ensure idempotency, preventing duplicate actions during retries.
Webhooks enable seamless integration, automation, and real-time data flow between WebEngage and external systems.
