VTEX · Example Payload

Vtex Hookconfiguration Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Hookconfiguration Example is an example object payload from VTEX, 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": "HookConfiguration",
  "method": "POST",
  "path": "/api/orders/hook/config",
  "summary": "VTex Create or update hook configuration",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "filter": {
          "type": "FromOrders",
          "expression": "value > 100",
          "disableSingleFire": false
        },
        "hook": {
          "url": "https://endpoint.example/path",
          "headers": {
            "key": "value"
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Domain": "Fulfillment",
        "OrderId": "v52277740atmc-01",
        "State": "ready-for-handling",
        "LastState": "window-to-cancel",
        "LastChange": "2019-08-14T17:11:39.2550122Z",
        "CurrentChange": "2019-08-14T17:12:48.0965893Z",
        "Origin": {
          "Account": "automacaoqa",
          "Key": "vtexappkey-appvtex"
        }
      }
    }
  ]
}