latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

Webhook

Retrieves a list of webhooks

Retrieves a list of webhooks

get/admin/webhooks.json

Query parameters

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).

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).

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.

limitnumber

Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.

since_idnumber

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

topicstring

Show webhook subscriptions with a given topic. Valid topics are: app/uninstalled, carts/create, carts/update, checkouts/create, checkouts/delete, checkouts/update, collection_listings/add, collection_listings/remove, collection_listings/update, collections/create, collections/delete, collections/update, customer_groups/create, customer_groups/delete, customer_groups/update, customers/create, customers/delete, customers/disable, customers/enable, customers/update, draft_orders/create, draft_orders/delete, draft_orders/update, fulfillment_events/create, fulfillment_events/delete, fulfillments/create, fulfillments/update, order_transactions/create, orders/cancelled, orders/create, orders/delete, orders/fulfilled, orders/paid, orders/partially_fulfilled, orders/updated, product_listings/add, product_listings/remove, product_listings/update, products/create, products/delete, products/update, refunds/create, shop/update, themes/create, themes/delete, themes/publish, themes/update, inventory_levels/connect, inventory_levels/update, inventory_levels/disconnect, inventory_items/create, inventory_items/update, inventory_items/delete, locations/create, locations/update, locations/delete, tender_transactions/create

Response

OK

Example response

{
  "webhooks": [
    {
      "address": "https://apple.com/uninstall",
      "created_at": 901431826,
      "fields": [
        "id",
        "updated_at"
      ],
      "format": "json",
      "id": 901431826,
      "metafield_namespaces": [
        "google",
        "inventory"
      ],
      "topic": "app/uninstalled",
      "updated_at": 901431826
    }
  ]
}