BigCommerce · Example Payload

Bigcommerce Createwebhooks Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createwebhooks Example is an example object payload from BigCommerce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createWebhooks",
  "method": "POST",
  "path": "/hooks",
  "summary": "BigCommerce Create a Webhook",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "application/json",
      "example": {
        "data": {
          "id": 18048287,
          "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
          "store_hash": "sftg45fsd",
          "created_at": 1561488106,
          "updated_at": 1561488106,
          "scope": "store/order/*",
          "destination": "https://665b65a6.ngrok.io/webhooks",
          "is_active": true,
          "headers": {
            "custom-key": "developer-defined value"
          }
        },
        "meta": {
          "pagination": {
            "count": 5,
            "current_page": 1,
            "links": {
              "current": "?limit=100&page=1",
              "next": "?limit=100&page=1",
              "previous": "?limit=100&page=1"
            },
            "per_page": 100,
            "total": 5,
            "total_pages": 1
          }
        }
      }
    }
  ]
}