BigCommerce
Webhooks
Manage Webhooks Bulk

Webhooks v3

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

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

  • 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

  • events_history_enabled
    booleandeprecated

    Deprecated. Boolean value that identifies whether events are stored that could not be received.

    Example: true

  • headers
    object

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

example

Response

Body

object | application/json
  • data

  • meta
    object

application/json

Get Webhooks

GET /hooks

Request

Returns a list of all webhooks on a store associated to the client_id used to authenticate the request.

Note: BigCommerce determines the client_id from the access_token.

Authentication

  • X-Auth-Token in header - required

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
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

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

  • scope in query - string

    Enables user to filter for webhooks by scope.

  • destination in query - string

    Enables user to filter for webhooks by destination.

example

Response

Body

object | application/json
  • data
    array[object]

  • meta
    object

Did you find what you were looking for?