VTEX · Schema

Hook

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
url string
headers object
View JSON Schema on GitHub

JSON Schema

vtex-hook-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Hook",
  "title": "Hook",
  "required": [
    "url",
    "headers"
  ],
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    },
    "headers": {
      "$ref": "#/components/schemas/Headers"
    }
  },
  "example": {
    "url": "https://endpoint.example/path",
    "headers": {
      "key": "value"
    }
  }
}