The Webhook Configurations page allows you to set up and manage webhooks, which are automated messages sent from Optimove to an external system. This is a powerful, advanced feature used for API integrations, sending campaign data to third-party services, or triggering actions in other platforms (e.g., sending promo codes to an external loyalty system or updating a separate CRM).

Prerequisites

• You must have an Admin role to access this page.
• You must have a valid destination Webhook URL from the external system you wish to send data to.
• This is a highly technical feature. It is strongly recommended to set this up in collaboration with a developer or your Customer Success Manager.

Navigating to Webhook Configurations

1. Click the Settings icon in the main navigation menu.
2. Under the Cross-Channel Settings category, select Webhook Configurations.

A Guide to the Webhook Configurations Screen

The main page lists all currently configured webhooks, showing their Webhook Name, the Channel Name they are associated with, their Channel ID, and the number of Attributes being sent.

How to Add a New Webhook

1. From the main page, click the + Add New Webhook button.
2. The "New Webhook" screen will appear.

   

3. Fill in the configuration details:
   • Webhook Name: A unique, friendly name for your reference (e.g., "Loyalty Platform Promo Hook").
   • Webhook URL: The main destination URL of the external system that will receive the data. Click Validate to ensure the URL is reachable.
   • File Size: The maximum number of rows (i.e., customers) to include in a single file or batch sent via the webhook.
   • Event ID: The default ID for the main event this webhook will listen for.
   • Channel Name: Select the Optimove channel this webhook is associated with.
   • Attributes: Select the specific customer attributes you want to send in the webhook payload (e.g., first_name, email, loyalty_tier).
   • Identifier: Select the primary customer identifier to use (e.g., Customer ID, Email).

How to Add Specific Event URLs (Optional)

You can also configure different URLs for specific events within the same webhook configuration. This is useful if your external system has different endpoints for different actions.

1. From the "New Webhook" or "Edit Webhook" screen, click + Add Event.
2. The "Add New Event" modal will appear.

   

3. Select the specific Event from the dropdown.
4. Enter the unique Webhook URL for this specific event. You can also click Copy from Main URL to use the default URL you set on the main screen.
5. Click Save.

How to Edit or Delete a Webhook

1. From the main list, click the pencil icon (✎) on the right-hand side of the webhook you wish to modify.

   

2. The "Edit" screen will appear, allowing you to update any of the fields.
3. To permanently remove the webhook, click the trash can icon (🗑️) on the main list and confirm the action.
4. Click Save to apply any changes.