Create Private API Key
Before setting up your Omnisend integration, please ensure that you already have an Omnisend account correctly set up for your store. You'll need to create a new API Key from your Omnisend dashboard. Be sure to copy the API key so that you can enter it into the Givy settings.
In Omnisend, click on your account name in the top-right corner, and choose Store settings. Next, select API keys from the navigation bar.
Click the Create API key button. We recommend the following settings:
Name: Givy
Permissions:
Contacts
Events
Be sure to copy your API key right away!
Enable the Integration
In Givy, go to the Integrations page, find Omnisend, and click the Configure button.
Next, past your Omnisend API key into the text field, and click Save. If the key is valid, the status of the integration will become Active.
Send Test Events to Omnisend
Now that the integration is active, you can start sending events to your Omnisend account. While testing, we recommend using the setting Givy & Omnisend, which will continue sending emails via Givy while you configure your Omnisend emails.
You can decide which emails will be sent to Omnisend by clicking the pencil icon and making your selection.
Events will now start being sent to Omnisend. For each email even that is configured to use Omnisend, we recommend creating an email template and Flow in your Omnisend account.
To see the data sent in each event, see the Payload Data section below.
Finalize the Integration
When you have thoroughly tested your integration, we recommend enabling the Omnisend Flow, and having these events sent only via Omnisend. To do this, on the Emails page, change the setting from Givy & Omnisend to only Omnisend.
Payload Data
Each email will have its own set of data. Use this information to build customized emails in Omnisend. These are sent as properties, and will appear in the event details for the Omnisend account.
Gift Card Created
Event Name: Gift Card Created
Profile Used: Purchaser
"givy_gift_card_code" => "card_code_here"
"givy_gift_card_image" => "https://app-host-name.com/media/card.jpg"
"givy_gift_card_expiry" => null
"givy_gift_value" => "123.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => false
Gift Card Gifted (Email)
Event Name: Gift Card Created - Email Delivery
Profile Used: Recipient
"givy_recipient_email" => "[email protected]"
"givy_recipient_name" => "Kate"
"givy_purchaser_email" => "[email protected]"
"givy_purchaser_name" => "Bob"
"givy_gift_card_code" => "card_code_here"
"givy_gift_card_image" => "https://app-host-name.com/media/card.jpg"
"givy_gift_card_expiry" => null
"givy_gift_value" => "123.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => true
"givy_send_method" => "EMAIL"
"givy_custom_message" => "adsfasdfasd"
"givy_gif_url" => null
"givy_view_message_url" => null
"givy_redemption_url" => "https://test.myshopify.com/a/givy/redeem/as9as"
"givy_purchase_session_locale" => null
"givy_purchase_session_currency" => null
Gift Card Gifted (Link)
Event Name: Gift Card Created - Link Delivery
Profile Used: Purchaser
"givy_recipient_name" => "Kate"
"givy_purchaser_email" => "[email protected]"
"givy_purchaser_name" => "Bob"
"givy_gift_card_code" => "fasfasdfasdfasd"
"givy_gift_card_image" => "https://app-host-name.com/grey_gift_card.jpg"
"givy_gift_card_expiry" => null
"givy_gift_value" => "123.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => true
"givy_send_method" => "UNIQUE_LINK"
"givy_custom_message" => "adsfasdfasd"
"givy_gif_url" => null
"givy_view_message_url" => null
"givy_redemption_url" => "https://short.com/K8sh2H2"
"givy_purchase_session_locale" => null
"givy_purchase_session_currency" => null
Gift Card Gifted (Print)
Event Name: Gift Card Created - Print Delivery
Profile Used: Purchaser
"givy_recipient_name" => "Kate"
"givy_purchaser_email" => "[email protected]"
"givy_purchaser_name" => "Bob"
"givy_gift_card_code" => "fasfasdfasdfasd"
"givy_gift_card_image" => "https://app-host-name.com/grey_gift_card.jpg"
"givy_gift_card_expiry" => null
"givy_gift_value" => "123.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => true
"givy_send_method" => "PRINT"
"givy_custom_message" => "adsfasdfasd"
"givy_gif_url" => null
"givy_view_message_url" => null
"givy_redemption_url" => "https://short.com/K8sh2H2"
"givy_purchase_session_locale" => null
"givy_purchase_session_currency" => null
Merchandise Gifted (Email)
Event Name: Merchandise Gifted - Email Delivery
Profile Used: Recipient
"givy_recipient_email" => "[email protected]"
"givy_recipient_name" => "Kate"
"givy_purchaser_email" => "[email protected]"
"givy_purchaser_name" => "Bob"
"givy_product_image" => "https://image.com/thing-one/thing-two.png"
"givy_product_name" => "Really Cool Product"
"givy_product_variant_name" => "Cool variant"
"givy_product_quantity" => 1
"givy_gift_value" => "250.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => true
"givy_send_method" => "EMAIL"
"givy_custom_message" => "adsfasdfasd"
"givy_gif_url" => null
"givy_view_message_url" => null
"givy_redemption_url" => "https://test.myshopify.com/a/givy/redeem/abc"
"givy_purchase_session_locale" => null
"givy_purchase_session_currency" => null
Merchandise Gifted (Link)
Event Name: Merchandise Gifted - Link Delivery
Profile Used: Purchaser
"givy_recipient_name" => "Kate"
"givy_purchaser_email" => "[email protected]"
"givy_purchaser_name" => "Bob"
"givy_product_image" => "https://image.com/thing-one/thing-two.png"
"givy_product_name" => "Really Cool Product"
"givy_product_variant_name" => "Cool variant"
"givy_product_quantity" => 1
"givy_gift_value" => "250.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => true
"givy_send_method" => "UNIQUE_LINK"
"givy_custom_message" => "adsfasdfasd"
"givy_gif_url" => null
"givy_view_message_url" => null
"givy_redemption_url" => "https://short.com/K8sh2H2"
"givy_purchase_session_locale" => null
"givy_purchase_session_currency" => null
Merchandise Gifted (Print)
Event Name: Merchandise Gifted - Print Delivery
Profile Used: Purchaser
"givy_recipient_name" => "Kate"
"givy_purchaser_email" => "[email protected]"
"givy_purchaser_name" => "Bob"
"givy_product_image" => "https://image.com/thing-one/thing-two.png"
"givy_product_name" => "Really Cool Product"
"givy_product_variant_name" => "Cool variant"
"givy_product_quantity" => 1
"givy_gift_value" => "250.00"
"givy_gift_value_currency" => "USD"
"givy_sent_as_gift" => true
"givy_send_method" => "PRINT"
"givy_custom_message" => "adsfasdfasd"
"givy_gif_url" => null
"givy_view_message_url" => null
"givy_redemption_url" => "https://short.com/K8sh2H2"
"givy_purchase_session_locale" => null
"givy_purchase_session_currency" => null
Gift Sent
Event Name: Notification - Gift Sent
Profile Used: Purchaser
"givy_recipient_email" => "[email protected]",
"givy_recipient_name" => "Kate",
"givy_purchaser_email" => "[email protected]",
"givy_purchaser_name" => "Bob",
"givy_gift_value" => "123.00",
"givy_gift_value_currency" => "USD",
"givy_sent_as_gift" => true,
"givy_send_method" => "EMAIL",
"givy_custom_message" => null,
"givy_gif_url" => null,
"givy_view_message_url" => null,
"givy_purchase_session_locale" => null,
"givy_purchase_session_currency" => null,
"givy_gift_card_code" => "fasfasdfasdfasd",
"givy_gift_card_image" => "https://app-host-name.com/grey_gift_card.jpg",
"givy_gift_card_expiry" => null,
Gift Redeemed
Event Name: Notification - Gift Redeemed
Profile Used: Purchaser
"givy_recipient_email" => "[email protected]",
"givy_recipient_name" => "Kate",
"givy_purchaser_email" => "[email protected]",
"givy_purchaser_name" => "Bob",
"givy_gift_value" => "123.00",
"givy_gift_value_currency" => "USD",
"givy_sent_as_gift" => true,
"givy_send_method" => "EMAIL",
"givy_custom_message" => null,
"givy_gif_url" => null,
"givy_view_message_url" => null,
"givy_purchase_session_locale" => null,
"givy_purchase_session_currency" => null,
"givy_gift_card_code" => "fasfasdfasdfasd",
"givy_gift_card_image" => "https://app-host-name.com/grey_gift_card.jpg",
"givy_gift_card_expiry" => null,
Gift Used
Event Name: Notification - Gift Used
Profile Used: Purchaser
"givy_recipient_email" => "[email protected]",
"givy_recipient_name" => "Kate",
"givy_purchaser_email" => "[email protected]",
"givy_purchaser_name" => "Bob",
"givy_gift_value" => "123.00",
"givy_gift_value_currency" => "USD",
"givy_sent_as_gift" => true,
"givy_send_method" => "EMAIL",
"givy_custom_message" => null,
"givy_gif_url" => null,
"givy_view_message_url" => null,
"givy_purchase_session_locale" => null,
"givy_purchase_session_currency" => null,
"givy_gift_card_code" => "fasfasdfasdfasd",
"givy_gift_card_image" => "https://app-host-name.com/grey_gift_card.jpg",
"givy_gift_card_expiry" => null,