Simple Activation Flow

This guide explains the simple activation flow, which works for both scheduled and real-time triggered campaigns. This flow is designed for fast, low-effort integrations where your system's main role is to initiate the process, after which Optimove's services take care of the operational logic.

This approach is perfect for standardized, repeatable promotions or any campaign where speed to market is a priority and you do not need to apply complex custom logic before a reward is granted.

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.

  1. Deploy an Endpoint: Your system must expose an HTTP POST endpoint that can receive campaign event notifications from Optimove.
  2. Register the Listener: Use the RegisterEventListener API to register your endpoint. For scheduled campaigns, you must provide EventTypeID: 5. (For triggered campaigns, refer to the full setup guide on registering real-time listeners).

Step 2: The Activation Process

Once your listener is registered, the following process will occur each time a campaign runs.

Sequence Diagram for the Simple Activation Flow

Sequence Diagram for the Simple Activation Flow

1. Optimove Triggers Your Webhook

When an Optimove campaign is executed (either at a predefined time or in real-time), it sends a webhook notification to your registered endpoint. This payload will contain details like the campaignId.

2. Your System Hands Off to the Publisher

Your system's primary responsibility is to hand the process off to the optipromo service.

  • For Scheduled Campaigns, you will first call GET GetCampaignCustomers to retrieve the full list of customers, and then POST that list to the publisher.
  • For Triggered Campaigns, you will simply identify the single customer from the webhook and forward that trigger to the publisher.

3. Parallel Actions Occur

Once the hand-off is complete, two processes happen simultaneously:

  • Optimove's Backend Process: The optipromo service automatically handles all the backend logic: it validates customer eligibility against tiers and budgets, assigns the correct reward, and updates the customer's status.
  • Customer-Side Activation: In parallel, the customer can activate their allocated reward on your website or app.

API Reference

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

Next Steps

  • To learn about a flow that gives your system full control over the validation process, see the next guide: ➡️ Advanced Activation Flow