WatchRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/snoopscan-com/json-schema/snoopscan-com-watch-request-schema.json",
  "title": "WatchRequest",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/snoopscan-com-openapi.json#/components/schemas/WatchRequest",
  "properties": {
    "keywords": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Keywords",
      "description": "Words or phrases to look for, up to 20 with `competitors`. Whole words, any case."
    },
    "competitors": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Competitors",
      "description": "Keywords for a competitor. A post that matches one of these and none of `keywords` is sorted as `competitor`."
    },
    "exclude": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Exclude",
      "description": "Words that remove a post from the results when it contains any of them."
    },
    "platforms": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Platforms",
      "description": "Where to look: reddit, hackernews, bluesky, youtube, threads, web, github, feeds. Default is all of them."
    },
    "feeds": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Feeds",
      "description": "RSS or Atom feed addresses to read (a Substack, a blog, a forum), up to 10. Read when `platforms` includes feeds; new entries that name a keyword as a whole word become mentions."
    },
    "categories": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Categories",
      "description": "Categories to keep: bug_report, complaint, question, buying_intent, praise, competitor, other. Posts sorted elsewhere are dropped. Default is all."
    },
    "customWords": {
      "anyOf": [
        {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Customwords",
      "description": "Your own words for a category, added to the built-in ones. Example: {\"buying_intent\": [\"any tips\"]}."
    },
    "intervalMinutes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Intervalminutes",
      "description": "How often to check, in minutes: 5 to 10,080. Default 15."
    },
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "title": "Name",
      "description": "A name for the watch."
    },
    "webhook": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Webhook",
      "description": "A URL to POST to with `mention.created` for each new mention. Signed with your key's webhook secret."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name"
  ]
}