Choose a version:

Anchor to eventBridgeWebhookSubscriptionUpdate

eventBridgeWebhookSubscriptionUpdate

mutation

Deprecated. Use webhookSubscriptionUpdate instead.

Updates an Amazon EventBridge webhook subscription.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of the webhook subscription to update.

Anchor to webhookSubscriptionwebhookSubscription

•EventBridgeWebhookSubscriptionInput!

required

Specifies the input fields for an EventBridge webhook subscription.

Show input fields

Was this section helpful?

Anchor to EventBridgeWebhookSubscriptionUpdatePayload returnsEventBridgeWebhookSubscriptionUpdatePayload returns

Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields
Anchor to webhookSubscriptionwebhookSubscription •WebhookSubscription: The webhook subscription that was updated.

Show fields

Was this section helpful?

Examples

Update a webhook subscription from HTTP to Amazon EventBridge

Query

mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
  eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
    userErrors {
      field
      message
    }
    webhookSubscription {
      id
      topic
      endpoint {
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }
}

Variables

{
  "id": "gid://shopify/WebhookSubscription/525699895",
  "webhookSubscription": {
    "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
    "format": "JSON"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) { eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookEventBridgeEndpoint { arn } } } } }",
 "variables": {
    "id": "gid://shopify/WebhookSubscription/525699895",
    "webhookSubscription": {
      "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
      "format": "JSON"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
    eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
      userErrors {
        field
        message
      }
      webhookSubscription {
        id
        topic
        endpoint {
          ... on WebhookEventBridgeEndpoint {
            arn
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/WebhookSubscription/525699895",
        "webhookSubscription": {
            "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
            "format": "JSON"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
    eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
      userErrors {
        field
        message
      }
      webhookSubscription {
        id
        topic
        endpoint {
          ... on WebhookEventBridgeEndpoint {
            arn
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/WebhookSubscription/525699895",
  "webhookSubscription": {
    "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
    "format": "JSON"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
      eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
        userErrors {
          field
          message
        }
        webhookSubscription {
          id
          topic
          endpoint {
            ... on WebhookEventBridgeEndpoint {
              arn
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/WebhookSubscription/525699895",
        "webhookSubscription": {
            "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
            "format": "JSON"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
  eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
    userErrors {
      field
      message
    }
    webhookSubscription {
      id
      topic
      endpoint {
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/WebhookSubscription/525699895",
  "webhookSubscription": {
    "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
    "format": "JSON"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
        eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
          userErrors {
            field
            message
          }
          webhookSubscription {
            id
            topic
            endpoint {
              ... on WebhookEventBridgeEndpoint {
                arn
              }
            }
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/WebhookSubscription/525699895",
        "webhookSubscription": {
            "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
            "format": "JSON"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "eventBridgeWebhookSubscriptionUpdate": {
    "userErrors": [],
    "webhookSubscription": {
      "id": "gid://shopify/WebhookSubscription/525699895",
      "topic": "ORDERS_CREATE",
      "endpoint": {
        "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source"
      }
    }
  }
}

eventBridgeWebhookSubscriptionUpdate reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {

eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {

userErrors {

field

message

}

webhookSubscription {

topic

endpoint {

... on WebhookEventBridgeEndpoint {

arn

}

}`,

{

variables: {

"id": "gid://shopify/WebhookSubscription/525699895",

"webhookSubscription": {

"arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",

"format": "JSON"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
  eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
    userErrors {
      field
      message
    }
    webhookSubscription {
      id
      topic
      endpoint {
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) { eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) { userErrors { field message } webhookSubscription { id topic endpoint { ... on WebhookEventBridgeEndpoint { arn } } } } }",
 "variables": {
    "id": "gid://shopify/WebhookSubscription/525699895",
    "webhookSubscription": {
      "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
      "format": "JSON"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
    eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
      userErrors {
        field
        message
      }
      webhookSubscription {
        id
        topic
        endpoint {
          ... on WebhookEventBridgeEndpoint {
            arn
          }
        }
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/WebhookSubscription/525699895",
        "webhookSubscription": {
            "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
            "format": "JSON"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
      eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
        userErrors {
          field
          message
        }
        webhookSubscription {
          id
          topic
          endpoint {
            ... on WebhookEventBridgeEndpoint {
              arn
            }
          }
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/WebhookSubscription/525699895",
        "webhookSubscription": {
            "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
            "format": "JSON"
        }
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
    eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
      userErrors {
        field
        message
      }
      webhookSubscription {
        id
        topic
        endpoint {
          ... on WebhookEventBridgeEndpoint {
            arn
          }
        }
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/WebhookSubscription/525699895",
  "webhookSubscription": {
    "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
    "format": "JSON"
  }
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
  eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
    userErrors {
      field
      message
    }
    webhookSubscription {
      id
      topic
      endpoint {
        ... on WebhookEventBridgeEndpoint {
          arn
        }
      }
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/WebhookSubscription/525699895",
  "webhookSubscription": {
    "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
    "format": "JSON"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation eventBridgeWebhookSubscriptionUpdate($id: ID!, $webhookSubscription: EventBridgeWebhookSubscriptionInput!) {
        eventBridgeWebhookSubscriptionUpdate(id: $id, webhookSubscription: $webhookSubscription) {
          userErrors {
            field
            message
          }
          webhookSubscription {
            id
            topic
            endpoint {
              ... on WebhookEventBridgeEndpoint {
                arn
              }
            }
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/WebhookSubscription/525699895",
        "webhookSubscription": {
            "arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",
            "format": "JSON"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/WebhookSubscription/525699895",

"webhookSubscription": {

"arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source",

"format": "JSON"

}

Response

JSON

{

"eventBridgeWebhookSubscriptionUpdate": {

"userErrors": [],

"webhookSubscription": {

"id": "gid://shopify/WebhookSubscription/525699895",

"topic": "ORDERS_CREATE",

"endpoint": {

"arn": "arn:aws:events:us-east-1::event-source/aws.partner/shopify.com/755357713/test-event-source"

}