For the complete documentation index, see llms.txt. This page is also available as Markdown.

Omnisend

Omnisend is an Email Service Provider that supports email and SMS marketing based on event tracking and other segmentation of contacts.


Website


Adding the Plugin

Navigate to Admin -> Plugins -> Email Service Providers.

Select the Omnisend title.

Click Activate.

Fill in your Omnisend apiKey found here: https://app.omnisend.com/integrations/api-keys

Click Connect.


Standard Event Tracking

Standard Event Tracking includes these events:

  • Started Checkout

  • Placed Order

  • Paid for Order

  • Ordered Product

  • Fulfilled Order

  • Cancelled Order

  • Refunded Order

  • Subscription Restarted

Add Standard Event Tracking for a campaign by editing the plugin and clicking +Route.

Then change the Checkout Champ Campaign filter to a specific campaign or All Campaigns and click Create.


Other Campaign Routes

Routes for other Customer Types can be added and will be sent to Omnisend as custom events.

Tags (comma separated) can be added to other routes that will be set on the Contact at Omnisend and also sent as event properties.


Properties Sent to Omnisend

Properties sent on all events as applicable
  • platform: Checkout Champ

  • orderID

  • orderDate

  • orderType

  • orderStatus

  • campaign

  • externalOrderId

  • billingAddress

  • shippingAddress

  • currency

  • lineItems

    • productID: campaignProductId in the CRM

    • productPrice

    • productQuantity

    • productSKU

    • productTitle

    • productDiscount

    • productDescriptor

    • billingCycleType

    • productDescription

    • productCategory

    • productImageURL

    • productVariantID

    • productVariantTitle

    • externalVariantDetailId

    • productVariantImageURL

    • txnResponse

    • nextBillDate

    • purchaseStatus

    • refundRemaining

  • value

  • shippingPrice

  • subTotalPrice

  • totalPrice

  • totalTax

  • totalDiscount

  • refundRemaining

  • totalAmount

  • fulfillmentStatus

  • shippingMethod

  • tracking

    • code

    • courierTitle

  • tags

  • billingCycleNumber

  • customer / campaign level custom fields

  • Order custom1-5 values

Started Checkout
  • abandonedCheckoutURL (includes products in the query string)

Ordered Product
  • product

    • productID

    • productPrice

    • productQuantity

    • productSKU

    • productTitle

    • productVariantTitle

    • productDiscount

    • productDescriptor

Cancelled Order
  • cancelReason

Refunded Order
  • totalRefundedAmount

Subscription Restarted
  • Product Name

  • Purchase ID

  • Subscription Status: Active

  • Next Bill Date


Subscribing contacts to channels

Contacts will be subscribed based on the emailOptIn and marketingOptIn parameters sent when the customer was created in the CRM or otherwise updated.

Customers without email or SMS contact enabled in the CRM will be sent to Omnisend as non subscribed.

Last updated