BigCommerce Docs

Return a webhook by ID.

X-Auth-Tokenstring

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

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

webhook_idintegerRequired>=1

The ID of a Webhook.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Example response

dataobject

metaany

401

Unauthorized Error

404

Not Found Error

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

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

1	{
2	"data": {
3	"id": 18048287,
4	"client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
5	"store_hash": "sftg45fsd",
6	"scope": "store/order/created",
7	"destination": "https://665b65a6.ngrok.io/webhooks",
8	"headers": {
9	"custom-key": "developer-defined value"
10	},
11	"is_active": true,
12	"created_at": 1561488106,
13	"updated_at": 1561488106
14	},
15	"meta": {}
16	}

1	{
2	"data": {
3	"id": 18048287,
4	"client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
5	"store_hash": "sftg45fsd",
6	"scope": "store/order/created",
7	"destination": "https://665b65a6.ngrok.io/webhooks",
8	"headers": {
9	"custom-key": "developer-defined value"
10	},
11	"is_active": true,
12	"created_at": 1561488106,
13	"updated_at": 1561488106
14	},
15	"meta": {}
16	}

Get Webhook

$	curl https://api.bigcommerce.com/stores/store_hash/v3/hooks/22561593 \
>	-H "X-Auth-Token: <apiKey>"