WebhookSubscriptionDeletePayload

The ID of the deleted webhook subscription.

The list of errors that occurred from executing the mutation.

Removes an existing webhook subscription, stopping all future event notifications for that subscription. This mutation provides a clean way to deactivate webhooks when they're no longer needed.

For example, when an app feature is disabled or when you need to change webhook configurations, you can delete the old webhook subscription to prevent unnecessary event delivery and potential errors. Alternatively, for endpoint changes, you might consider updating the existing subscription instead of deleting and recreating it.

Use webhookSubscriptionDelete to:

• Clean up unused webhook subscriptions
• Stop event delivery to deprecated endpoints
• Remove subscriptions during app uninstallation
• Reduce unnecessary resource usage by removing unused subscriptions

The mutation returns the deleted subscription's ID for confirmation when successful. Validation errors are included in the response if you request them in your query, as with all GraphQL mutations.

Learn more about managing webhook subscriptions.

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.