Skip to main content

Set up a Shopify webhook listener

Kathyana Rule
  • Updated

What is a webhook?

Webhooks send an HTTP POST message over the web in real-time to an endpoint when an event occurs in an application. When an event triggers a webhook request, the source application sends a message to a specified URL, and a webhook listener receives the message and then executes operations according to the message's content. Webhooks can return response codes from integrator.io.

Contents

Set up a Shopify webhook and edit details

Start establishing a webhook connection to Shopify while working in a new or existing integration by clicking Add source.

In the resulting Application list, select Shopify and specify Listen to real-time data from source application. Fill in the required * fields.

Note: When creating your Shopify webhook, you must add a fake Key (secret) (such as 123 or ABC) to generate your Public URL. After generating the URL, create your webhook in Shopify and add the secret that appears after saving your webhook.

Required fields Definition
Name * Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting among a list of connections you’ve created.
Description Describe your resource so that other users can quickly understand what it is doing without reading through all the fields and settings. Be sure to highlight any nuances that a user should be aware of before using your resource in their flows. Also, as you make changes to the resource, be sure to keep this field up to date.
Key (secret) * Navigate to Shopify to retrieve your secret. Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s secret safe. When editing this form later, you must generate this value again; it is stored only when the connection is saved and never displayed as text.
Public URL * Generate a public URL for your webhook listener, and then share this URL with the webhook provider through that provider's UI or API. Each webhook provider, like GitHub or Shopify, supports a mechanism to configure a URL where you want webhook data sent. Please provide them with this generated URL.

Create your webhook in Shopify

  1. Sign in to your Shopify admin account.
  2. From your Shopify admin page, click Settings → Notifications and scroll down to Webhooks.
  3. Click the Create webhook button. A new window should appear.
  4. From the first drop-down, select the Event.
  5. From the Format dropdown list, select JSON.
  1. In the URL field, add the Public URL generated in your integrator.io Shopify webhook (automatically generated, required): Use the + button to generate a public URL for this webhook listener.
  1. From the Webhook API version dropdown list, select the desired version.
  2. Click Save.
  3. Your Shopify secret is located at the bottom of your newly created webhook. Copy and paste this value into your Key (secret) in integrator.io.
Shopify webhook with highlighted secret

Related articles

Comments

0 comments

Please sign in to leave a comment.