For AI agents: visit https://developer.optimove.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Optimove Developers Hub
HomeGuidesAPI ReferenceChange log
Optimove Developers Hub
Guides
HomeGuidesAPI ReferenceChange log

Starting your Journey with Optimove

  • Tech Onboarding Gateway
    • Optimove Data Delivery Guide
    • Your Data Extraction & Load (ETL)
    • Data Integrity and Validation
  • Prepare Your Data for Optimove
    • Data Delivery to Optimove
      • Data Sources Documentation: Files
      • Data Sources Documentation: Database
      • Data Sources Documentation: API
      • Guide for Iceberg Integration (Databricks)
      • Guide for Iceberg Integration (Snowflake on AWS)
      • Guide for Iceberg Integration (Snowflake on GCP)
    • In-Depth Data Handling: Missing Files & Data Validation
    • Vertical Data Schemas
      • Bingo
      • Casino
      • Ecommerce
      • Forex
      • Lottery
      • Multi: Sport and Casino
      • Poker
      • Social Gaming
      • Sport
      • Streaming
      • Sweepstakes Casino
      • Trading
    • Batch Data Process
      • Check Missing Files: Ensuring Your Data Integrity in Optimove
      • Data Volume Validation: Ensuring Data Completeness in Optimove
      • Batch Process Trigger Daily API
    • Batch Data QA Processes
  • Optimove's OOTB Solution Guide
    • Casino Vertical
    • Sports Vertical
    • Multi - Sports & Casino Vertical
    • E-Commerce Vertical
    • Forex Vertical
    • Social Gaming Vertical
    • Sweepstakes Casino Vertical
    • Lottery Vertical
  • Optimove's OOTB Events for Data Integration
    • Mandatory Properties for Standard Events
    • General Events
      • Login Event
      • Registration Initiated
      • Registration Failed
      • Registration Completed
      • User Details Update
      • Adact Game Finished
    • Gaming & Sports Events
      • Deposit Initiated
      • Deposit Limit Updated
      • Deposit Limit Exceeded
      • Standard Deposit
      • Deposit Cancellation
      • Standard Withdrawal
      • Withdrawal Cancellation
      • Game Launch
      • Sweepstakes Game Launch
      • Game Session
      • Sweepstakes Game Session
      • Game Close
      • Sweepstakes Game Close
      • Added to Betslip
      • Bet Placement
      • Bet Settled
      • Balance Update
      • Sweepstakes Balance Update
      • Self-Exclusion: Initiated
      • Self-Exclusion: Activated
      • Self-Exclusion: Updated
      • Self-Exclusion: Violation Attempt
      • Self-Exclusion: Lifted
    • Ecommerce Events
      • Product View
      • Added to Wishlist
      • Removed from Wishlist
      • Added to Cart
      • Items in Cart
      • Removed from Cart
      • Online Order (Opti-X)
      • Empty Cart (Opti-X)
      • Cart Checkout Completed
      • Order Started
      • Order Completed
      • Order Shipped
      • Order Fulfilled
      • Order Failed
      • Product Refund
      • Product Return

Integration Guides

  • API Integrations
    • Integrate your Service with Optimove
    • Setting Up Conditional Execution
    • API ChannelID Values
  • 3rd Party Vendors Integration
    • Promotion System Integration
      • Promo System Safeguards and Best Practices
    • External Vendors Campaign Engagement Metrics
  • Others
    • SFTP Integration
    • Sandbox Environment Usage Guide
  • MCP
    • Optimove MCP Connector

Developer Tools & SDKs

  • Real-Time Triggers Guides
    • Web SDK
      • Web SDK Integration
      • Verifying the SDK Implementation
      • Preference Center Integration Guide
    • Optimove Basic Web SDK Using GTM
      • Initializing the SDK
      • Tracking Page Visits
      • Recognizing a Returning Customer
      • Registering a New Customer
    • Reporting Server-Side Events
    • Integrating Optimove with Segment
    • Monitoring Events in Optimove
  • Customer Lists API
    • Introduction to the Customer Lists API

Native Channels

  • OptiMobile
  • OptiWeb
    • Webpage Pop-up Tech Guide
    • Web Push Platform Setup
    • Embedded Messaging
      • Getting Started with Embedded Messaging
      • SDK Setup & Local Development
      • Using the SDK for Embedded Messaging
      • Styling & Customization
      • Supporting Visitors & Customers
      • Web Inbox
  • OptiMail
    • Key Attributes for IP Warm-up and Email Deliverability
    • Adding Optimove DNS Records to Your CDN
    • How to Fill Out the Optimail Request Form
    • Product Recommendation Model
    • Product Recommendation Campaigns
    • Transactional Emails
    • Guide to SSL Click Tracking for Optimove and SendGrid
  • OptiText SMS
    • Integrate your Service with SMS API
    • OptiText SMS - Same Day Registration Events
  • Data Connections API
    • Using your Data Connections
    • Walkthrough example for an Upload Data Connection
    • Managing Data Connections
  • Message Archiving
  • Overlay Messaging
    • Getting Started with Overlay Messaging

Personalize

  • Getting Started with Optimove Personalize
    • Gaming
      • Gaming Inventory
      • Availability filters
      • Overview of Data Usage in Gaming
    • Sports
      • Sports Inventory
      • Overview of Data Usage in Sports
    • Ecommerce
      • Prepare your Data Ecommerce Inventory
      • Overview of Data Usage in Ecomm
    • Lottery & Bingo
    • How to Deploy Opti-X Banners
  • API Guides
    • Recommend API Guide
    • Intelligent Layouts API Guide
    • Reference API Guide
    • Momentum API Guide
    • Smart Search API Guide
      • Gaming Filtering
      • Sports Filtering
    • AWS Kinesis producer testing
    • API Triggered Campaigns

Gamify

  • Minigames
    • API & Webhooks: An Overview
      • How to Set Up Webhook Integration
      • Webhook Event Reference
    • Data Connections
      • Encoding Customer IDs for Gamify Campaigns
  • Loyalty
    • Custom Widget UI Integration Guide
    • Gamify Loyalty Webhooks
    • Gamify Loyalty Widget SDK
    • Loyalty Events Schema

OptiPromo

  • Introduction to Integrating with OptiPromo
    • Glossary
  • Promotion Setup & Configuration
    • Creating a Basic Promotion
    • Configuring Promotion Tiers
    • Setting Budgets and Constraints
    • Adding Custom Properties
    • Managing the Promotion Lifecycle
  • Campaign Execution
    • Auto Flow
    • Advanced Control Flow
  • Reference
    • API vs. UI Functionality

Optimove Data Share

  • Data Share Overview
  • Data Shares Glossary
  • Data Sharing Methods
  • Roles & Permissions
  • Data Unloading to S3
  • Data Unloading to GCS
  • Entity Relation Diagram
  • FAQ
  • Campaigns
    • Scheduled Campaigns
      • Legacy Views - Scheduled Campaigns
    • Triggered Campaigns
      • Legacy Views - Triggered Campaigns
    • Campaign Results
      • Legacy Views - Campaign Results
    • Targeted and Excluded Customers
      • Legacy Views - Targeted Customers
      • Triggered - Engaged Customers
  • Customer Profiles
    • Views - Customer Profiles
  • Engagement Activity
  • Purchases / Games
  • Data Share Use Cases
    • Data Samples
    • Customer 360 View
    • Control Groups Customers
    • Predictive Values View
    • Targeted Yesterday
  • Changelog and Release Notes
    • Version V1_2
  • Streams
    • Campaigns in Streams
    • Customers in Treatments
    • Streams Results
    • Streams Metadata

Security, Authentication, and Compliance

  • Security
    • IP Allow List
  • Single Sign-On Authentication
    • Azure AD Single-Sign-On
    • Okta Single-Sign-On
    • Jumpcloud Single-Sign-On
    • Duo Single-Sign-On
  • Compliance
    • Remove PII Guide
    • SR Code 5.1.12

For Partners

  • Ways of Working
    • Onboarding & Integrations Set Up
    • Business as Usual
  • Recommended Real-Time Events

Changelog

  • RSS Feed Changelog

Data Share Use Cases

In this section you will find step-by-step instructions for common use cases that can be done within Data Share. It is recommended to visit Data Share Glossary to get familiar with the terms and their equivalents in Optimove UI.

Data Samples

Customer 360 View

Customers in Control Group

Predictive Values

Customers Targeted Yesterday