Shopify Events | Cloud Elements Help Center

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports webhook events for Shopify. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance. For more information about webhooks at Shopify including the currently available webhooks, see their webhooks documentation.

Configure Webhooks Through the UI

To configure webhooks through the UI, follow the same steps to authenticate an element instance, and then turn on events. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Webhooks Through API

Use the /instances endpoint to authenticate with Shopify and create an element instance with webhooks enabled.

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To authenticate an element instance with webhooks:

Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.

Construct a JSON body as shown below (see Parameters):

{
  "element": {
    "key": ""
  },
  "providerData": {
    "code": "<AUTHORIZATION_GRANT_CODE>"
  },
  "configuration": {
    "oauth.callback.url": "<CALLBACK_URL>",
    "oauth.api.key": "<CONSUMER_KEY>",
    "oauth.api.secret": "<CONSUMER_SECRET>",
    "event.notification.enabled": true,
    "shopify.webhook.topics": "<LIST_OF_WEBHOOK_TOPICS>",
    "event.notification.callback.url": "<CALLBACK_URL>",
    "event.notification.signature.key": "<SIGNATURE_KEY>"
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Call the following, including the JSON body you constructed in the previous step:
```
POST /instances
```
Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": ""
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "oauth.callback.url": "https://mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxx"
    "event.notification.enabled": true,
    "shopify.webhook.topics": "orders/create, orders/updated, customers/create",
    "event.notification.callback.url": "https://mycoolapp.com/events",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in the Cloud Elements are in code formatting.

Parameter	Description	Data Type
`key`	The element key.	string
`code`	The authorization grant code returned from the API provider in an OAuth2 authentication workflow.	string
Name `name`	The name for the element instance created during authentication.	Body
`oauth.callback.url`	The URL where you want to redirect users after they grant access. This is the Callback URL that you noted in the API Provider Setup section.
`oauth.api.key`	The Client ID from Shopify. This is the Client ID that you noted in the API Provider Setup section.	string
`oauth.api.secret`	The Client Secret from Shopify. This is the Client Secret that you noted in the API Provider Setup section.	string
Events Enabled `event.notification.enabled`	Optional. Identifies that events are enabled for the element instance. Default: `false`.	boolean
Event Notification Callback URL `event.notification.callback.url`	The URL where you want Cloud Elements to send the events.	string
Callback Notification Signature Key `event.notification.signature.key`	Optional. A user-defined key for added security to show that events have not been tampered with.	string
Webhook Topics `shopify.webhook.topics`	Comma separated list of supported webhook topics that you want to monitor. See Shopify's webhooks documentation for a list of supported wehooks.	string
tags	Optional. User-defined tags to further identify the instance.	string