Own Shopify? Customize your docs with AI search, analytics, and more.

Claim your docs

GET

Retrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.

https://shopify.com/admin/api/2020-04/webhooks.json

https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-04

Access Token Required: API Key

Query Params

addressstring

Retrieve webhook subscriptions that send the POST request to this URI.

created_at_maxstring

Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).

created_at_minstring

Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).

fieldsstring

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.

limitstring

Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. (default: 50, maximum: 250)

since_idstring

Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.

topicstring

Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>

updated_at_minstring

Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).

updated_at_maxstring

Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://shopify.com/admin/api/2020-04/webhooks.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Retrieves a list of webhooks. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. To learn more, see Making requests to paginated REST Admin API endpoints.

https://shopify.com/admin/api/2020-04/webhooks.json

https://shopify.dev/docs/admin-api/rest/reference/events/webhook#index-2020-04

Access Token Required: API Key

Query Params

addressstring

Retrieve webhook subscriptions that send the POST request to this URI.

created_at_maxstring

Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).

created_at_minstring

Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).

fieldsstring

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.

limitstring

Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error. (default: 50, maximum: 250)

since_idstring

Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.

topicstring

Show webhook subscriptions with a given topic. For a list of valid values, refer to the topic property.>

updated_at_minstring

Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).

updated_at_maxstring

Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://shopify.com/admin/api/2020-04/webhooks.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}