younifyd
Menu

webhookSubscriptionCreate

Creates a webhook subscription that notifies your App when specific events occur in a shop.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the webhookSubscriptionCreate action (under Webhook).
  3. Fill in the fields below, then reference the result from later steps as {{webhooksubscriptioncreate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
mutation WebhookSubscriptionCreate($topic: WebhookSubscriptionTopic!, $webhookSubscription: WebhookSubscriptionInput!) {
  webhookSubscriptionCreate(
    topic: $topic
    webhookSubscription: $webhookSubscription
  ) {
    userErrors {
      field
      message
    }
    webhookSubscription {
      apiVersion {
        displayName
        handle
        supported
      }
      callbackUrl
      createdAt
      endpoint
      filter
      format
      id
      includeFields
      legacyResourceId
      metafieldNamespaces
      metafields {
        key
        namespace
      }
      name
      topic
      updatedAt
      uri
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

topicstringrequired

The type of event that triggers the webhook.

One ofTAX_SUMMARIES_CREATEAPP_UNINSTALLEDAPP_SCOPES_UPDATECARTS_CREATECARTS_UPDATECHANNELS_DELETECHECKOUTS_CREATECHECKOUTS_DELETECHECKOUTS_UPDATECUSTOMER_PAYMENT_METHODS_CREATECUSTOMER_PAYMENT_METHODS_UPDATECUSTOMER_PAYMENT_METHODS_REVOKECOLLECTION_LISTINGS_ADDCOLLECTION_LISTINGS_REMOVECOLLECTION_LISTINGS_UPDATECOLLECTION_PUBLICATIONS_CREATECOLLECTION_PUBLICATIONS_DELETECOLLECTION_PUBLICATIONS_UPDATECOLLECTIONS_CREATECOLLECTIONS_DELETECOLLECTIONS_UPDATECUSTOMER_GROUPS_CREATECUSTOMER_GROUPS_DELETECUSTOMER_GROUPS_UPDATECUSTOMERS_CREATECUSTOMERS_DELETECUSTOMERS_DISABLECUSTOMERS_ENABLECUSTOMERS_UPDATECUSTOMERS_PURCHASING_SUMMARYCUSTOMERS_MARKETING_CONSENT_UPDATECUSTOMERS_WHATS_APP_MARKETING_CONSENT_UPDATECUSTOMER_TAGS_ADDEDCUSTOMER_TAGS_REMOVEDCUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATEDISPUTES_CREATEDISPUTES_UPDATEDRAFT_ORDERS_CREATEDRAFT_ORDERS_DELETEDRAFT_ORDERS_UPDATE

webhookSubscriptionobjectrequired

Specifies the input fields for a webhook subscription.

formatstring

One ofJSONXML

includeFieldsarray<string>
filterstring
metafieldNamespacesarray<string>
metafieldsarray<object>2 fields
namestring
callbackUrlstring
uristring
json
{
  "topic": "TAX_SUMMARIES_CREATE",
  "webhookSubscription": {
    "format": "JSON",
    "includeFields": [
      "string"
    ],
    "filter": "string",
    "metafieldNamespaces": [
      "string"
    ],
    "metafields": [
      {
        "key": "string",
        "namespace": "string"
      }
    ],
    "name": "string",
    "callbackUrl": "string",
    "uri": "string"
  }
}

Response

Read the result with {{webhooksubscriptioncreate.response.data.data.webhookSubscriptionCreate}}. If the API returns errors, the step fails and they are at {{webhooksubscriptioncreate.response.data.errors}}.

userErrorsarray<object>
fieldobject
messageobject
webhookSubscriptionobject
apiVersionobject3 fields
callbackUrlstring
createdAtstring
endpointobject4 fields

This field can return one of several different object shapes — properties from every possible shape are shown together.

filterstring
formatstring

One ofJSONXML

idstring
includeFieldsarray<object>
legacyResourceIdstring
metafieldNamespacesarray<object>
metafieldsarray<object>
namestring
topicstring

One ofTAX_SUMMARIES_CREATEAPP_UNINSTALLEDAPP_SCOPES_UPDATECARTS_CREATECARTS_UPDATECHANNELS_DELETECHECKOUTS_CREATECHECKOUTS_DELETECHECKOUTS_UPDATECUSTOMER_PAYMENT_METHODS_CREATECUSTOMER_PAYMENT_METHODS_UPDATECUSTOMER_PAYMENT_METHODS_REVOKECOLLECTION_LISTINGS_ADDCOLLECTION_LISTINGS_REMOVECOLLECTION_LISTINGS_UPDATECOLLECTION_PUBLICATIONS_CREATECOLLECTION_PUBLICATIONS_DELETECOLLECTION_PUBLICATIONS_UPDATECOLLECTIONS_CREATECOLLECTIONS_DELETECOLLECTIONS_UPDATECUSTOMER_GROUPS_CREATECUSTOMER_GROUPS_DELETECUSTOMER_GROUPS_UPDATECUSTOMERS_CREATECUSTOMERS_DELETECUSTOMERS_DISABLECUSTOMERS_ENABLECUSTOMERS_UPDATECUSTOMERS_PURCHASING_SUMMARYCUSTOMERS_MARKETING_CONSENT_UPDATECUSTOMERS_WHATS_APP_MARKETING_CONSENT_UPDATECUSTOMER_TAGS_ADDEDCUSTOMER_TAGS_REMOVEDCUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATEDISPUTES_CREATEDISPUTES_UPDATEDRAFT_ORDERS_CREATEDRAFT_ORDERS_DELETEDRAFT_ORDERS_UPDATE

updatedAtstring
uristring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.