Advanced Activation Flow

This guide explains the advanced activation flow, which works for both scheduled and real-time triggered campaigns. This model provides your system with full flexibility to embed its own custom business logic, such as fraud checks, VIP segmentation, or dynamic reward scaling, into the promotion delivery process.

This flow is designed for complex eligibility workflows where you need to orchestrate the validation and reward delivery process in response to a direct customer action.

Step 1: Register a Webhook Listener (One-Time Setup)

To begin, your system must be able to receive notifications from Optimove. This requires registering an endpoint that you control.

  • For scheduled campaigns, use the RegisterEventListener API with EventTypeID: 5.
  • For triggered campaigns, use the POST /conditional-execution/v2/triggered/webhooks/ endpoint.

Step 2: The Activation Process

In this flow, your system handles the initial data processing and then waits for a customer action to complete the validation and reward delivery.

Sequence Diagram for the Advanced Activation Flow

Sequence Diagram for the Advanced Activation Flow

1. Optimove Triggers Your Webhook

When an Optimove campaign is executed, it sends a webhook notification to your registered endpoint. Your system can now retrieve the targeted customers (for scheduled campaigns) or identify the single triggered customer.

2. Your System Performs Initial Logic

Your system can now apply any preliminary custom logic, such as scrubbing the customer list, checking consent, or performing initial fraud checks.

3. Customer-Initiated Reward Activation

The final steps of the process are initiated by a direct action from the customer on your website or app (e.g., clicking a "Claim Reward" button). When this occurs, your system performs the following sequence:

  • a. Approach OptiPromo for Validation: Your system calls the OptiPromo validateCustomers API to confirm the customer's eligibility and retrieve the specific reward details.
  • b. Activate Reward on Your Side: After receiving a successful validation response, your system activates the reward for the customer on your platform (e.g., adds free spins to their account). You can also apply any post-validation logic at this stage.
  • c. Approve with Optimove: Finally, your system must make a final API call to Optimove to update the customer's promotion status, which confirms that the reward has been delivered.

What OptiPromo Still Handles

Even in this advanced flow, OptiPromo's promotion engine still automatically handles the core business logic during the validation step:

  • Promotion rule enforcement
  • Reward tier assignment
  • Budget enforcement

API Reference

Your system will need to make the following calls to implement this flow.