# Omnisend

<figure><img src="/files/EpAVOCWdJWkVX7x9KulY" alt="" width="350"><figcaption></figcaption></figure>

***

### Website

{% embed url="<https://www.omnisend.com/>" %}

***

### Adding the Plugin

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

Select the Omnisend title.

<figure><img src="/files/fNncsg0wgZ4ZIJwYJEio" alt=""><figcaption></figcaption></figure>

Click Activate.

<figure><img src="/files/FCrtPPpaZReJrjOvtpOW" alt=""><figcaption></figcaption></figure>

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.

<figure><img src="/files/lcfrtzv9nefmpcvt9dK2" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/BV5lALLCqZwMtdcZ1MDO" alt=""><figcaption></figcaption></figure>

***

### 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.

<figure><img src="/files/RzQoa8HlDY7e43v41vdr" alt=""><figcaption></figcaption></figure>

***

### Properties Sent to Omnisend

<details>

<summary>Properties sent on all events as applicable</summary>

* platform: Checkout Champ&#x20;
* 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

</details>

<details>

<summary>Started Checkout</summary>

* abandonedCheckoutURL (includes products in the query string)

</details>

<details>

<summary>Ordered Product</summary>

* product
  * productID
  * productPrice
  * productQuantity
  * productSKU
  * productTitle
  * productVariantTitle
  * productDiscount
  * productDescriptor

</details>

<details>

<summary>Cancelled Order</summary>

* cancelReason

</details>

<details>

<summary>Refunded Order</summary>

* totalRefundedAmount

</details>

<details>

<summary>Subscription Restarted</summary>

* Product Name
* Purchase ID
* Subscription Status: Active
* Next Bill Date

</details>

***

### 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.&#x20;

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.checkoutchamp.com/crm/plugins/email-service-providers/omnisend.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.