GET /admin/api/{api_version}/webhooks.json
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.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-shopify-access-token |
String | No |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
updated_at_min |
String | No |
Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00). |
topic |
String | No |
Show webhook subscriptions with a given topic. For a list of valid values, refer to the |
limit |
String | No |
Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.(default: 50)(maximum: 250) |
created_at_max |
String | No |
Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00). |
since_id |
String | No |
Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id. |
fields |
String | No |
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. |
address |
String | No |
Retrieve webhook subscriptions that send the POST request to this URI. |
created_at_min |
String | No |
Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00). |
updated_at_max |
String | No |
Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.