RESTIntegrationsWebhooks

Create Webhook

Creates a webhook. Only one webhook at a time can be created. Custom headers can be added. Destination URL must be served on port 443 (custom ports are not currently supported).

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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Headers

AcceptstringOptionalDefaults to application/json

Request

This endpoint expects an object.
scopestringRequired
Event you subscribe to.
destinationstringRequired

URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.

is_activebooleanOptional
Boolean value that indicates whether the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity.
headersobject or nullOptional
Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.

Response

dataobject
metaany

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error