Shopify webhooks enable apps to receive notifications about particular events in a shop. They are useful for keeping your app in sync with Shopify data or as a trigger to perform additional actions after events occur, providing a performant alternative to continuously polling for changes.
openapi: 3.1.0
info:
title: Shopify Admin REST About Webhooks API
description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
version: 2025-01
contact:
name: Shopify
url: https://shopify.dev/docs/api/admin-rest
email: api@shopify.com
license:
name: Shopify API Terms
url: https://www.shopify.com/legal/api-terms
x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
description: Shopify Admin REST API
variables:
store:
default: my-store
description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Webhooks
description: Manage webhook subscriptions
paths:
/webhooks.json:
get:
operationId: listWebhooks
summary: Shopify Retrieve a list of webhooks
description: Retrieves a list of webhook subscriptions for the app.
tags:
- Webhooks
parameters:
- name: topic
in: query
description: Filter by webhook topic
schema:
type: string
- name: limit
in: query
description: Maximum number of results (max 250, default 50)
schema:
type: integer
default: 50
maximum: 250
- name: since_id
in: query
description: Return webhooks after the specified ID
schema:
type: integer
- name: fields
in: query
description: Comma-separated list of fields to include
schema:
type: string
responses:
'200':
description: A list of webhooks
content:
application/json:
schema:
type: object
properties:
webhooks:
type: array
items:
$ref: '#/components/schemas/Webhook'
post:
operationId: createWebhook
summary: Shopify Create a webhook subscription
description: Creates a new webhook subscription. When the specified event occurs Shopify sends an HTTP POST to the provided address.
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- webhook
properties:
webhook:
$ref: '#/components/schemas/WebhookInput'
responses:
'201':
description: The created webhook
content:
application/json:
schema:
type: object
properties:
webhook:
$ref: '#/components/schemas/Webhook'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/webhooks/count.json:
get:
operationId: getWebhookCount
summary: Shopify Retrieve a count of webhooks
description: Retrieves a count of existing webhook subscriptions.
tags:
- Webhooks
parameters:
- name: topic
in: query
description: Count webhooks for a specific topic
schema:
type: string
responses:
'200':
description: The webhook count
content:
application/json:
schema:
type: object
properties:
count:
type: integer
/webhooks/{webhook_id}.json:
get:
operationId: getWebhook
summary: Shopify Retrieve a single webhook
description: Retrieves a single webhook subscription by ID.
tags:
- Webhooks
parameters:
- name: webhook_id
in: path
required: true
description: The ID of the webhook
schema:
type: integer
responses:
'200':
description: The requested webhook
content:
application/json:
schema:
type: object
properties:
webhook:
$ref: '#/components/schemas/Webhook'
put:
operationId: updateWebhook
summary: Shopify Update a webhook subscription
description: Updates an existing webhook subscription.
tags:
- Webhooks
parameters:
- name: webhook_id
in: path
required: true
description: The ID of the webhook
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- webhook
properties:
webhook:
$ref: '#/components/schemas/WebhookInput'
responses:
'200':
description: The updated webhook
content:
application/json:
schema:
type: object
properties:
webhook:
$ref: '#/components/schemas/Webhook'
delete:
operationId: deleteWebhook
summary: Shopify Delete a webhook subscription
description: Deletes a webhook subscription.
tags:
- Webhooks
parameters:
- name: webhook_id
in: path
required: true
description: The ID of the webhook
schema:
type: integer
responses:
'200':
description: Webhook deleted successfully
/admin/api/2020-01/webhooks.json:
get:
summary: Shopify Retrieves A List Of Webhooks
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-01
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: created_at_max
description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: created_at_min
description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
- in: query
name: limit
description: "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)"
schema: {}
required: false
- in: query
name: since_id
description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
- in: query
name: updated_at_min
description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: updated_at_max
description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202001_get_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
post:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
topic: orders/create
address: https://whatever.hostname.com/
format: json
summary: Subscribe to order creation webhooks
example2:
value:
webhook:
body: foobar
summary: Trying to create a webhook subscription without an address and topic will return a 422 - Unprocessable Entity error
summary: Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-01
parameters:
- in: query
name: format
description: "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)"
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202001_create_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-01/webhooks/count.json:
get:
summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-01
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202001_get_webhooks_count
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-01/webhooks/{webhook_id}.json:
get:
summary: Shopify Retrieves A Single Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-01
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202001_get_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
put:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
id: 4759306
address: https://somewhere-else.com/
summary: Update a webhook subscription so that it POSTs to a different address
summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-01
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202001_update_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
delete:
summary: Shopify Delete A Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-01
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202001_delete_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-04/webhooks.json:
get:
summary: Shopify Retrieves A List Of Webhooks
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-04
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: created_at_max
description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: created_at_min
description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
- in: query
name: limit
description: "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)"
schema: {}
required: false
- in: query
name: since_id
description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
- in: query
name: updated_at_min
description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: updated_at_max
description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202004_get_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
post:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
topic: orders/create
address: https://whatever.hostname.com/
format: json
summary: Subscribe to order creation webhooks
example2:
value:
webhook:
body: foobar
summary: Trying to create a webhook subscription without an address and topic will return a 422 - Unprocessable Entity error
summary: Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-04
parameters:
- in: query
name: format
description: "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)"
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202004_create_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-04/webhooks/count.json:
get:
summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-04
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202004_get_webhooks_count
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-04/webhooks/{webhook_id}.json:
get:
summary: Shopify Retrieves A Single Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-04
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202004_get_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
put:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
id: 4759306
address: https://somewhere-else.com/
summary: Update a webhook subscription so that it POSTs to a different address
summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-04
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202004_update_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
delete:
summary: Shopify Delete A Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-04
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202004_delete_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-07/webhooks.json:
get:
summary: Shopify Retrieves A List Of Webhooks
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-07
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: created_at_max
description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: created_at_min
description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
- in: query
name: limit
description: "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)"
schema: {}
required: false
- in: query
name: since_id
description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
- in: query
name: updated_at_min
description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: updated_at_max
description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202007_get_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
post:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
topic: orders/create
address: https://whatever.hostname.com/
format: json
summary: Subscribe to order creation webhooks
example2:
value:
webhook:
body: foobar
summary: Trying to create a webhook subscription without an address and topic will return a 422 - Unprocessable Entity error
summary: Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-07
parameters:
- in: query
name: format
description: "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)"
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202007_create_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-07/webhooks/count.json:
get:
summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-07
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202007_get_webhooks_count
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-07/webhooks/{webhook_id}.json:
get:
summary: Shopify Retrieves A Single Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-07
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202007_get_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
put:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
id: 4759306
address: https://somewhere-else.com/
summary: Update a webhook subscription so that it POSTs to a different address
summary: Shopify Update A Webhook Subscription's Topic Or Address Uris
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#update-2020-07
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202007_update_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
delete:
summary: Shopify Delete A Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#destroy-2020-07
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
tags:
- Webhooks
responses:
'200':
description: ''
operationId: deprecated_202007_delete_webhooks_param_webhook_id
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-10/webhooks.json:
get:
summary: Shopify Retrieves A List Of Webhooks
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-10
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: created_at_max
description: 'Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: created_at_min
description: 'Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
- in: query
name: limit
description: "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.\n (default: 50, maximum: 250)"
schema: {}
required: false
- in: query
name: since_id
description: Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
- in: query
name: updated_at_min
description: 'Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
- in: query
name: updated_at_max
description: 'Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: get_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
post:
requestBody:
content:
application/json:
schema: {}
examples:
example1:
value:
webhook:
topic: orders/create
address: https://whatever.hostname.com/
format: json
summary: Subscribe to order creation webhooks
example2:
value:
webhook:
body: foobar
summary: Trying to create a webhook subscription without an address and topic will return a 422 - Unprocessable Entity error
summary: Shopify Create A New Webhook Subscription By Specifying Both An Address And A Topic
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#create-2020-10
parameters:
- in: query
name: format
description: "Use this parameter to select the data format for the payload. Valid values are json and xml.\n (default: json)"
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: create_webhooks
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-10/webhooks/count.json:
get:
summary: Shopify Retrieves A Count Of Existing Webhook Subscriptions
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#count-2020-10
parameters:
- in: query
name: address
description: Retrieve webhook subscriptions that send the POST request to this URI.
schema: {}
required: false
- in: query
name: topic
description: 'Show webhook subscriptions with a given topic.
For a list of valid values, refer to the topic property.>'
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: get_webhooks_count
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
/admin/api/2020-10/webhooks/{webhook_id}.json:
get:
summary: Shopify Retrieves A Single Webhook Subscription
description: https://shopify.dev/docs/admin-api/rest/reference/events/webhook#show-2020-10
parameters:
- in: path
name: webhook_id
required: true
schema:
type: string
description: webhook_id
- in: query
name: fields
description: Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
schema: {}
required: false
tags:
- Webhooks
responses:
'200':
description: ''
operationId: get_webhooks_param_webhook_id
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-webhooks-api-openapi.yml