Docs
Webhooks
Webhooks
Manage Webhooks Single

Manage Webhooks (Single)

Create a Webhook

POST /hooks

Request

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-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

Body

object | application/json

  • scope    string
    required

    Event you subscribe to.
    Example: store/order/created

  • destination    string
    required

    URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.
    Example: https://665b65a6.ngrok.io/webhooks

  • is_active    boolean

    Boolean value that indicates whether the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity.
    Example: true

  • headers    object or null

    Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.

example

{
"scope": "store/order/created",
"destination": "https://665b65a6.ngrok.io/webhooks",
"is_active": true,
"headers": {
"property1": "string",
"property2": "string"
}
}

Response

Body

object | application/json

  • data    object

  • meta

example

{
"data": {
"id": 18048287,
"client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
"store_hash": "sftg45fsd",
"created_at": 1561488106,
"updated_at": 1561488106,
"scope": "store/order/created",
"destination": "https://665b65a6.ngrok.io/webhooks",
"is_active": true,
"headers": {
"property1": "string",
"property2": "string"
}
},
"meta": null
}

Get a Webhook

GET /hooks/{webhook_id}

Request

Return a webhook by ID.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • webhook_id in path - integer
    required
    The ID of a Webhook.
    Example: 22561593
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string

example

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

Response

Example response

Body

object | application/json

  • data    object

  • meta

application/json

{
"data": {
"id": 18048287,
"client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
"store_hash": "sftg45fsd",
"created_at": 1561488106,
"updated_at": 1561488106,
"scope": "store/order/created",
"destination": "https://665b65a6.ngrok.io/webhooks",
"is_active": true,
"headers": {
"custom-key": "developer-defined value"
}
},
"meta": {}
}

Update a Webhook

PUT /hooks/{webhook_id}

Request

Updates a webhook. You can add custom headers. At least one field is required to perform an update.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • webhook_id in path - integer
    required
    The ID of a Webhook.
    Example: 22561593
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string

Body

object | application/json

  • scope    string

    Event you subscribe to.
    Example: store/order/created

  • destination    string

    URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.
    Example: https://665b65a6.ngrok.io/webhooks

  • is_active    boolean

    Boolean value that indicates whether the webhook is active or not.
    Example: true

  • headers    object or null

    Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.

example

{
"scope": "store/order/created",
"destination": "https://665b65a6.ngrok.io/webhooks",
"is_active": true,
"headers": {
"property1": "string",
"property2": "string"
}
}

Response

Example response

Body

object | application/json

  • data    object

  • meta

application/json

{
"data": {
"id": 18048287,
"client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
"store_hash": "sftg45fsd",
"created_at": 1561488106,
"updated_at": 1561488106,
"scope": "store/order/created",
"destination": "https://665b65a6.ngrok.io/webhooks",
"is_active": true,
"headers": {
"custom-key": "developer-defined value"
}
},
"meta": {}
}

Delete a Webhook

DELETE /hooks/{webhook_id}

Request

Deletes a webhook. Only one webhook at a time can be deleted. When a webhook is deleted, it is returned in the response as a 200 OK.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • webhook_id in path - integer
    required
    The ID of a Webhook.
    Example: 22561593
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string

example

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

Response

Example response

Body

object | application/json

  • data    object

  • meta

application/json

{
"data": {
"id": 18048287,
"client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
"store_hash": "sftg45fsd",
"created_at": 1561488106,
"updated_at": 1561488106,
"scope": "store/order/created",
"destination": "https://665b65a6.ngrok.io/webhooks",
"is_active": true,
"headers": {
"custom-key": "developer-defined value"
}
},
"meta": {}
}
Did you find what you were looking for?
Get WebhooksCreate a Webhook