Manage Webhooks Bulk

Manage Webhooks (Bulk)

Get Webhooks

GET /hooks

Request

Returns a list of all webhooks on a store associated to the client_id used to authenticate the request.

Note: BigCommerce determines the client_id from the access_token.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string
  • page in query - integer

    Page number.

    Example: 1
  • limit in query - integer

    Items count per page.

  • is_active in query - boolean

    Enables user to filter for webhooks that are active or not. A webhook subscription becomes deactivated after 90 days of inactivity.

    Example: true
  • scope in query - string

    Enables user to filter for webhooks by scope.

  • destination in query - string

    Enables user to filter for webhooks by destination.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/hooks' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json
  • data
    array[object]

  • meta
    object

Did you find what you were looking for?