> ## Documentation Index
> Fetch the complete documentation index at: https://getappfox.com/subscription/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Omnisend Integration

> Send Appfox subscription events to Omnisend, including created, paused, cancelled, and failed payments, to build Shopify subscriber automations.

The Omnisend integration sends subscription lifecycle events to your Omnisend account as custom events. Use these events to trigger automated workflows, build customer segments, and deliver personalized email and SMS campaigns based on subscription behavior.

## What it does

The Omnisend integration sends events when:

* A new subscription is created
* A subscription is cancelled
* A subscription is paused or resumed
* A subscription is updated (frequency, product, or other changes)
* Billing succeeds or fails
* A renewal is upcoming (upcoming renewal reminder)
* A payment card is expiring

These events appear in Omnisend as custom events associated with the customer's profile. You can trigger automation workflows and segment customers based on these events.

## How to connect

<Steps>
  <Step title="Get your Omnisend API Key">
    Log into Omnisend and go to **Store settings** → **API keys**. Click **Create API key**, name it (for example, Appfox), and enable the **Events** permission. Copy the key immediately — Omnisend only shows it once.
  </Step>

  <Step title="Open Integrations in Appfox">
    In Appfox, click **Settings** (or **Merchant dashboard**), then click **Integrations**.
  </Step>

  <Step title="Connect Omnisend">
    Find the **Omnisend** card and click **Connect**.
  </Step>

  <Step title="Enter your API Key">
    Paste your Omnisend API Key into the field.
  </Step>

  <Step title="Save">
    Click **Save Integration** to enable the connection.
  </Step>
</Steps>

<Note>
  The key needs the **Events** permission. Without it, Omnisend rejects the events and automations will not run. Appfox does not use a shared API key — each store connects with its own key, saved from the **Integrations** page.
</Note>

## Events and properties

Appfox sends the following custom events to Omnisend:

| Event Name | Triggered When |
| - | - |
| **Appfox Subscription Created** | A new subscription is created |
| **Appfox Subscription Updated** | A subscription is modified (frequency, product, etc.) |
| **Appfox Subscription Paused** | A subscription is paused by the customer or merchant |
| **Appfox Subscription Resumed** | A paused subscription is resumed |
| **Appfox Subscription Cancelled** | A subscription is cancelled |
| **Appfox Subscription Payment Successful** | A recurring billing attempt succeeds |
| **Appfox Subscription Payment Failed** | A recurring billing attempt fails |
| **Appfox Subscription Renewal Upcoming** | A renewal is coming up (sent before the next billing date) |
| **Appfox Subscription Card Expiring** | The customer's payment card is expiring soon |

### Event properties

Each event includes the following properties (when available). The shorter names match the fields Appfox sends to Klaviyo, so a flow you already designed there maps across directly:

* `contract` and `contractGid` — Shopify subscription contract ID (e.g., `gid://shopify/SubscriptionContract/123`)
* `status` — Subscription status (`ACTIVE`, `PAUSED`, `CANCELLED`)
* `order` and `orderName` — Most recent order name (e.g., `#1001`)
* `value` and `orderAmount` — Order amount (numeric)
* `currency` and `currencyCode` — Currency code (e.g., `USD`)

Additional properties may be included depending on the event (e.g., `failureReason` for payment failures, `nextBillingDate` for upcoming renewals, `cardExpiry` for expiring cards).

Contact information (email, first name, last name) is sent in the `contact` object. Omnisend creates or updates that contact from the event, so you do not import subscribers separately.

## Building automations in Omnisend

After connecting, you can create automation workflows in Omnisend triggered by subscription events:

### Welcome new subscribers

Trigger a welcome series when the **Appfox Subscription Created** event occurs. Example workflow:

1. **Trigger**: Appfox Subscription Created
2. **Wait**: 1 hour
3. **Send email**: Welcome to the subscription club! Here's what to expect.

### Win-back cancelled subscribers

Send a win-back offer when the **Appfox Subscription Cancelled** event occurs:

1. **Trigger**: Appfox Subscription Cancelled
2. **Wait**: 3 days
3. **Send email**: We miss you! Here's 15% off your next subscription.

### Failed payment recovery

Alert customers immediately when billing fails and follow up if they don't resolve it:

1. **Trigger**: Appfox Subscription Payment Failed
2. **Send email**: Oops! Your payment didn't go through. Update your card here.
3. **Wait**: 3 days
4. **Exit if**: Appfox Subscription Payment Successful (customer fixed their payment)
5. **Send email**: Don't lose your subscription! Update your payment now.

### Renewal reminders

Remind customers a few days before their next billing date:

1. **Trigger**: Appfox Subscription Renewal Upcoming
2. **Send email**: Your subscription renews in 3 days. Questions? Reply here.

### Card expiring alert

Proactively ask customers to update their payment info before their card expires:

1. **Trigger**: Appfox Subscription Card Expiring
2. **Send email**: Your card is expiring soon. Update it now to avoid interruptions.

### Paused subscription check-in

Reach out to customers who paused their subscription:

1. **Trigger**: Appfox Subscription Paused
2. **Wait**: 7 days
3. **Send email**: Still taking a break? Resume anytime — no hassle.

## Segmentation

Use subscription events to build customer segments in Omnisend:

* **Active subscribers**: Customers who have the **Appfox Subscription Created** event and no **Appfox Subscription Cancelled** event
* **At-risk subscribers**: Customers who triggered **Appfox Subscription Payment Failed** in the last 7 days
* **Recently cancelled**: Customers who triggered **Appfox Subscription Cancelled** in the last 30 days (perfect for win-back campaigns)
* **Long-term subscribers**: Customers with **Appfox Subscription Created** more than 6 months ago

## Troubleshooting

### Events not appearing in Omnisend

* Confirm your API Key is correct and still active in Omnisend
* Confirm the key includes the **Events** permission
* Wait a few minutes for events to appear (they're sent asynchronously)
* Check the customer profile in Omnisend to see if the event is listed under **Events** or **Activity**
* Open **Store settings** → **API keys** → **API Log** and look for rejected requests

### Automations not triggering

* Ensure the automation workflow is published (not in draft mode)
* Check that the trigger event name matches exactly: "Appfox Subscription Created" (case-sensitive in some automation builders)
* Verify the customer exists in Omnisend (they must have an email address)

### Duplicate events

* This usually means multiple webhooks or integrations are configured in Appfox for the same event. Check your integration settings and disable duplicates.

***

Need help? Contact [support@getappfox.com](mailto:support@getappfox.com).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.