Getting Started

The Flex developer platform provides three integration surfaces: an Ingestion API for pushing data into Flex, Webhooks for receiving real-time event notifications, and Exports for consuming campaign and reporting data.

Ingestion API

The Ingestion API allows you to synchronise your operational data with the Flex platform. The following entity types are supported:

Entities can be ingested in any order. For example, a transaction can be submitted before the associated customer or outlet exists in Flex. References are resolved once all entities are available.

For authentication and request formats, see Authentication and the API Reference.

Webhooks

Flex can notify your system of events in real-time via outbound webhooks. When a subscribed event occurs, Flex sends an HTTP POST request with a JSON payload to your registered endpoint.

Key characteristics: at-least-once delivery, exponential backoff retries for up to 24 hours, and a 10-second response timeout. Your handler must be idempotent.

For the full delivery contract, see Webhooks Overview. For request validation, see Signature Verification. For available event types, see Supported Webhooks.

Exports

Flex generates automated daily exports of campaign data in CSV format, delivered to a secure Google Cloud Storage (GCS) bucket. Exports for the previous day are typically available by 4 AM.

Available export files cover campaigns, campaign customers, campaign SKUs, opt-outs, and link statistics.

For access setup, see Access & Authentication. For file schemas, see Files & Formats. For data timing and change policies, see Data Availability & Changes.

Common Concepts

The following guides apply across all integration surfaces:

Need Help?

Contact us at [email protected]