Webhook

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/granite-md/json-schema/granite-md-webhook-schema.json",
  "title": "Webhook",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/granite-md-openapi.yaml#/components/schemas/Webhook",
  "type": "object",
  "required": [
    "id",
    "vault_id",
    "kind",
    "url",
    "description",
    "events",
    "actions",
    "folder",
    "ready",
    "granite_bot",
    "active",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "vault_id": {
      "type": "string",
      "format": "uuid"
    },
    "kind": {
      "$ref": "#/$defs/IntegrationKind"
    },
    "url": {
      "type": "string",
      "description": "Where triggers go: a masked copy of the tool's URL (the real address works as a\npassword); for Telegram `telegram:<chat id>`; empty for chat apps.\n"
    },
    "description": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/WebhookEventType"
      }
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/IntegrationAction"
      }
    },
    "folder": {
      "type": "string",
      "description": "Where new notes and the capture inbox go."
    },
    "inbound_url": {
      "type": "string",
      "description": "Where the service sends commands and actions."
    },
    "ready": {
      "type": "boolean",
      "description": "Everything requests are checked with is saved, so commands work."
    },
    "last_inbound_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the service last sent a verified command or action."
    },
    "granite_bot": {
      "type": "boolean",
      "description": "Telegram, Slack, and Discord: the integration uses Granite's own bot, so there is\nnothing to set up in the service; chats are connected with `connect`.\n"
    },
    "chats": {
      "type": "array",
      "description": "Granite's bot only, the chats connected to the integration.",
      "items": {
        "$ref": "#/$defs/IntegrationChat"
      }
    },
    "active": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "$defs": {
    "IntegrationAction": {
      "type": "string",
      "description": "What an integration may do: `capture` (plain messages to the inbox note), `create`,\n`append`, `daily` (today's daily note), `search`, `list` (a folder), `read`, `update`\n(replace the text), `move` and `delete` (a note or a whole folder), and `meeting`\n(notetakers only: save each finished meeting as a note).\n",
      "enum": [
        "capture",
        "create",
        "append",
        "daily",
        "search",
        "list",
        "read",
        "update",
        "move",
        "delete",
        "meeting"
      ]
    },
    "IntegrationChat": {
      "type": "object",
      "required": [
        "id",
        "name",
        "created_at"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string",
          "description": "The chat, channel, or server, as the service named it."
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "IntegrationKind": {
      "type": "string",
      "description": "The connected service. `webhook` is a custom endpoint. AI meeting notetakers\n(`read_ai`, `fathom`, `fireflies`, `tldv`, `otter`, `granola`, `circleback`, `avoma`,\n`meetgeek`) send finished meetings. `google_chat`, `webex`, and `ntfy` could only notify\nand can no longer be added.\n",
      "enum": [
        "slack",
        "teams",
        "mattermost",
        "discord",
        "telegram",
        "rocket_chat",
        "zulip",
        "shortcuts",
        "n8n",
        "pipedream",
        "zapier",
        "make",
        "ifttt",
        "activepieces",
        "power_automate",
        "webhook",
        "read_ai",
        "fathom",
        "fireflies",
        "tldv",
        "otter",
        "granola",
        "circleback",
        "avoma",
        "meetgeek",
        "google_chat",
        "webex",
        "ntfy"
      ]
    },
    "WebhookEventType": {
      "type": "string",
      "enum": [
        "*",
        "note.*",
        "member.*",
        "note.created",
        "note.updated",
        "note.moved",
        "note.deleted",
        "vault.shared",
        "member.added",
        "member.removed",
        "member.role_changed"
      ]
    }
  }
}