Get Admin Info

GET

https://api.bigcommerce.com/stores/:store_hash/v3/hooks/admin

GET

/stores/:store_hash/v3/hooks/admin

curl -G https://api.bigcommerce.com/stores/store_hash/v3/hooks/admin \
     -H "X-Auth-Token: <apiKey>" \
     -d is_active=true

{
  "data": {
    "emails": [
      "webhooks@example.com"
    ],
    "hooks_list": [
      {
        "id": 1,
        "client_id": "string",
        "store_hash": "string",
        "scope": "store/order/created",
        "destination": "string",
        "headers": {},
        "is_active": true,
        "created_at": 1561488106,
        "updated_at": 1561488106,
        "status": "inactive"
      }
    ],
    "blocked_domains": [
      {
        "destination": "string",
        "time_left": 1,
        "reasons": [
          {
            "failure_description": "string",
            "count": 1,
            "timestamp": 1
          }
        ]
      }
    ]
  },
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}

List all notification emails, webhooks, and denylisted domains associated with the API account.

Authentication

X-Auth-Tokenstring

OAuth scopes

None required. Create and manage webhooks with the default scope of an API account.

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

is_activebooleanOptional

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

Response

Successful operation.

dataobjectOptional

metaobjectOptional

Errors

401

Unauthorized Error