webhooks.ConfiguredWebhook

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/rollee/main/json-schema/rollee-webhooks-configured-webhook-schema.json",
  "title": "webhooks.ConfiguredWebhook",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rollee-company-api-openapi.yml#/components/schemas/webhooks.ConfiguredWebhook",
  "type": "object",
  "required": [
    "enabled",
    "method",
    "url"
  ],
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "headers": {
      "description": "optional key/value object corresponding to the headers that will be sent in the webhook request",
      "allOf": [
        {
          "$ref": "#/$defs/models.WebhookHeader"
        }
      ]
    },
    "kind": {
      "description": "the type of event that triggers the webhook",
      "type": "string"
    },
    "method": {
      "description": "http method POST or PUT",
      "type": "string"
    },
    "platform_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "secret": {
      "description": "optional secret for Rollee to compute a signature (HMAC SHA-512, base64 encoded) and send it in the X-Signature header",
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "url": {
      "description": "fully qualified url that will receive webhooks data",
      "type": "string"
    }
  },
  "$defs": {
    "models.WebhookHeader": {
      "type": "object",
      "additionalProperties": {}
    }
  }
}