VTEX · Schema

HookConfigurationRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
filter object
hook object
View JSON Schema on GitHub

JSON Schema

vtex-hookconfigurationrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HookConfigurationRequest",
  "title": "HookConfigurationRequest",
  "required": [
    "filter",
    "hook"
  ],
  "type": "object",
  "properties": {
    "filter": {
      "$ref": "#/components/schemas/HookFilter"
    },
    "hook": {
      "$ref": "#/components/schemas/Hook"
    }
  },
  "example": {
    "filter": {
      "type": "FromWorkflow",
      "status": [
        "order-completed",
        "handling",
        "ready-for-handling",
        "waiting-ffmt-authorization",
        "cancel"
      ]
    },
    "hook": {
      "url": "https://endpoint.example/path",
      "headers": {
        "key": "value"
      }
    }
  }
}