webhookSubscription

Returns a webhook subscription by ID. Building an app?

Use it in a workflow

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

Query

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

graphql

query WebhookSubscription($id: ID!) {
  webhookSubscription(id: $id) {
    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.

idstringrequired

The ID of the `WebhookSubscription` to return.

json

{
  "id": "string"
}

Response

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

apiVersionobject

displayNamestring

handlestring

supportedboolean

callbackUrlstring

createdAtstring

endpointobject

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

arnstring

callbackUrlstring

pubSubProjectstring

pubSubTopicstring

filterstring

formatstring

One ofJSONXML

idstring

includeFieldsarray<string>

legacyResourceIdstring

metafieldNamespacesarray<string>

metafieldsarray<object>

keyobject

namespaceobject

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.

Was this page helpful?