Shopify Webhooks

Owned by Tom Knuth
Last updated: Dec 18, 2023 by Tyler Martorano
3 min read

Checkout Champ supports Shopify’s refund create, customer update, cart creation, and cart update webhooks. Use this document to learn how to configure each.

 

These steps will need to be repeated for each Shopify plugin, even if each plugin is connected to the same Shopify store.

The Customer Update webhook updates email and phone. The webhook works for only the first store where an order is pushed.

Step 1 - Obtain Webhook Token from CheckoutChamp

Navigate to Admin > Plugins > Data Sources and open the appropriate Shopify store

Copy the Callback URL in the Webhook panel

 

Step 2 - Configure webhook on your Shopify Admin site

Navigate to Settings → Notifications

Scroll down to Webhooks and create a new webhook.

 

Event = Select the “Refund create”, or the “Customer update”, or the “Cart creation” and “Cart update” options - depending on which webhook you want to send to CheckoutChamp.

Each webhook event must be created separately inside Shopify.

Format = JSON

URL = Callback URL from your Shopify plugin

Webhook API Version = 2023-10

 

Once the webhook is created, copy the secret key to use in the next step.

 

Step 3 - Enter Secret Key in CheckoutChamp

Navigate back to Admin > Plugins > Data Sources and open the appropriate Shopify plugin

Paste the Secret Key into the secretKey field and then press Update.

The webhook setup is now complete. Be sure to create webhook notifications for each event that you want CheckoutChamp to receive.

Step 4 - Monitor for events

If you setup the refund created webhook, CheckoutChamp is now listening for refund webhooks from your Shopify store. Be sure to monitor refunds in both platforms to confirm the webhook is working as expected.

 

If you setup the Customer Update webhook then CheckoutChamp is now listening for email and phone updates from your Shopify store. If an order is sent to multiple stores then only the first store will provide updates back to Checkout Champ.

 

If you setup the cart webhooks then CheckoutChamp is now listening for those webhooks from your Shopify store. The Checkout Champ checkout page should be the exact same products, prices, and currency as the Shopify cart. If your Shopify store supports multi-currency then do ensure that all store currencies are setup on the Checkout Champ campaign.