.png)
Omnisend Integration Guide
Connect Omnisend with commerce, CRM, ERP, support, and data platforms through REST APIs, selected webhooks, and Martini workflows.
Omnisend integration options at a glance
Omnisend’s primary integration mechanism is a JSON REST API secured with an API key in the X-API-KEY header. The API supports Contacts, Events, Orders, Products, Carts, Campaigns, and related marketing data. Omnisend also provides webhook-style notifications for selected events and object changes, although coverage is not universal. Martini can consume the REST API, expose an endpoint for supported webhook notifications, and orchestrate scheduled synchronization for resources without event coverage. Workflows can paginate through API results, apply consent and identity rules, transform payloads, throttle requests, and retry transient failures without embedding credentials in integration logic.
Common Omnisend integration patterns
Common Omnisend data objects used in integrations
Authentication and security considerations
API-key authentication
Omnisend direct API access primarily uses an API key in the X-API-KEY HTTP header. Configure the key with only the permissions required for the integration.
Credential protection
Store Omnisend keys in Martini secrets or secure environment configuration rather than workflow logic or source code. Use separate credentials for non-production and production environments where possible.
Data protection
- Protect Contact identity, subscription, consent, and customer transaction data during transformation.
- Do not log API keys or unnecessary sensitive customer data.
- Validate inbound webhook requests and apply authorization controls to exposed Martini endpoints.
- Prevent stale source data from overriding Omnisend suppression or unsubscribe decisions.
Operational considerations for Omnisend integrations
Rate limits and pagination
Confirm the current Omnisend rate limits and treat list endpoints as paginated. Handle HTTP 429 responses with bounded exponential backoff, controlled concurrency, and scheduled batches.
Idempotency and ordering
Use stable source identifiers and event keys for Contacts, Orders, Products, Carts, and Events. Webhook and source-system events can arrive out of order, so compare timestamps or versions where available and use reconciliation workflows.
Schema and consent changes
Version mappings, validate required fields, and tolerate unknown JSON properties where appropriate. Treat subscription state as consent-sensitive data and prevent stale updates from re-subscribing Contacts.
Testing and monitoring
- Test authentication, pagination, rate limiting, rejected business states, and duplicate delivery.
- Separate transient failures from permanent validation or permission errors.
- Store checkpoints only after successful writes.
- Monitor workflow logs and preserve request context without exposing credentials.
Why use Martini instead of scripts or point-to-point integrations?
Orchestrate more than an API call
Scripts can call an Omnisend endpoint, but enterprise integrations also need identity resolution, consent rules, pagination, throttling, retries, reconciliation, and observability. Martini centralizes these concerns in maintainable workflows.
Support multiple integration modes
Martini can consume Omnisend REST APIs, expose an endpoint for selected webhook notifications, and run scheduled synchronization for unsupported or missed events. This avoids building separate point-to-point processes for each use case.
Reuse mappings and controls
Reusable workflows and mapping logic can standardize Contacts, Events, Orders, Products, and Carts across commerce, CRM, ERP, support, and data-platform integrations.
- Apply business rules before marketing data is sent.
- Handle retries and duplicate detection consistently.
- Keep API keys and environment-specific settings outside implementation logic.
- Provide operational checkpoints and error routes for long-running synchronizations.