webhookSubscriptions

List the store's webhook subscriptions (topic + delivery endpoint).

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the webhookSubscriptions action (under Webhook).
Fill in the fields below, then reference the result from later steps as {{webhooksubscriptions.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 WebhookSubscriptions($callbackUrl: URL, $uri: String, $format: WebhookSubscriptionFormat, $topics: [WebhookSubscriptionTopic!], $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: WebhookSubscriptionSortKeys, $query: String) {
  webhookSubscriptions(
    callbackUrl: $callbackUrl
    uri: $uri
    format: $format
    topics: $topics
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        apiVersion
        callbackUrl
        createdAt
        endpoint
        filter
        format
        id
        includeFields
        legacyResourceId
        metafieldNamespaces
        metafields
        name
        topic
        updatedAt
        uri
      }
    }
    nodes {
      apiVersion {
        displayName
        handle
        supported
      }
      callbackUrl
      createdAt
      endpoint
      filter
      format
      id
      includeFields
      legacyResourceId
      metafieldNamespaces
      metafields {
        key
        namespace
      }
      name
      topic
      updatedAt
      uri
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

callbackUrlstring

Callback URL to filter by.

uristring

URI to filter by. Supports an HTTPS URL, a Google Pub/Sub URI (pubsub://{project-id}:{topic-id}) or an Amazon EventBridge event source ARN.

formatstring

Response format to filter by.

One ofJSONXML

topicsarray<string>

List of webhook subscription topics to filter by.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofCREATED_ATID

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | created_at | time | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json

{
  "callbackUrl": "string",
  "uri": "string",
  "format": "JSON",
  "topics": [
    "TAX_SUMMARIES_CREATE"
  ],
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string"
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

apiVersionobject

callbackUrlobject

createdAtobject

endpointobject

filterobject

formatobject

idobject

includeFieldsobject

legacyResourceIdobject

metafieldNamespacesobject

metafieldsobject

nameobject

topicobject

updatedAtobject

uriobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?