Webhooks Admin
Get Admin Info
GET https://api.bigcommerce.com/stores/{store_hash}/v3/hooks/adminRequest
List all notification emails, webhooks, and denylisted domains associated with the API account.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- 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
example
Response
Successful operation.
Body
object | application/json
dataobject
Upsert Email Notifications
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/hooks/adminRequest
Update email addresses that are sent notification emails when any domain associated with the API account is denylisted or when a webhook is deactivated. Supports upsert functionality in the case that no email address exists yet.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
List of notification emails.
Body
object | application/json
emailsarray[string]
Example
Response
No Content
Did you find what you were looking for?