webhook_Base

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhook_Base",
  "title": "webhook_Base",
  "type": "object",
  "x-internal": false,
  "properties": {
    "scope": {
      "type": "string",
      "example": "store/order/*",
      "description": "Event you subscribe to."
    },
    "destination": {
      "type": "string",
      "example": "https://665b65a6.ngrok.io/webhooks",
      "description": "URL must be active, return a 200 response, and be served on port 443. Custom ports aren\u02bct currently supported."
    },
    "is_active": {
      "type": "boolean",
      "example": true,
      "description": "Boolean value that indicates whether the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity."
    },
    "events_history_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Deprecated. Boolean value that identifies whether events are stored that could not be received.",
      "deprecated": true
    },
    "headers": {
      "type": "object",
      "description": "Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.",
      "nullable": true,
      "properties": {},
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "scope",
    "destination"
  ]
}