webhookSubscriptionDelete

mutation

Deletes a 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.

Arguments

Anchor to idid • ID!required: The ID of the webhook subscription to delete.

Was this section helpful?

Anchor to WebhookSubscriptionDeletePayload returnsWebhookSubscriptionDeletePayload returns

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

Was this section helpful?

Remove an existing Webhook
webhookSubscriptionDelete reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation webhookSubscriptionDelete($id: ID!) {

webhookSubscriptionDelete(id: $id) {

userErrors {

field

message

}

deletedWebhookSubscriptionId

}

}`,

{

variables: {

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

);

const data = await response.json();

mutation webhookSubscriptionDelete($id: ID!) {
  webhookSubscriptionDelete(id: $id) {
    userErrors {
      field
      message
    }
    deletedWebhookSubscriptionId
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation webhookSubscriptionDelete($id: ID!) { webhookSubscriptionDelete(id: $id) { userErrors { field message } deletedWebhookSubscriptionId } }",
 "variables": {
    "id": "gid://shopify/WebhookSubscription/525699895"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation webhookSubscriptionDelete($id: ID!) {
    webhookSubscriptionDelete(id: $id) {
      userErrors {
        field
        message
      }
      deletedWebhookSubscriptionId
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/WebhookSubscription/525699895"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation webhookSubscriptionDelete($id: ID!) {
      webhookSubscriptionDelete(id: $id) {
        userErrors {
          field
          message
        }
        deletedWebhookSubscriptionId
      }
    }`,
    "variables": {
      "id": "gid://shopify/WebhookSubscription/525699895"
    },
  },
});

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 webhookSubscriptionDelete($id: ID!) {
    webhookSubscriptionDelete(id: $id) {
      userErrors {
        field
        message
      }
      deletedWebhookSubscriptionId
    }
  }
QUERY

variables = {
  "id": "gid://shopify/WebhookSubscription/525699895"
}

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

Input variables

JSON

{

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

}

Response

JSON

{

"webhookSubscriptionDelete": {

"userErrors": [],

"deletedWebhookSubscriptionId": "gid://shopify/WebhookSubscription/525699895"

}