API reference · schema

WebhookRequest

5 fields · used by 1 operations

Last reviewed 2026-11-06

Fields

Field	Type	Meaning
`url` required	string	min length `8` · max length `2000`
`events`	array of string
`description`	string or null	max length `200`
`format`	string	cain (signed JSON envelope), splunk_hec, xsiam, datadog, sentinel, slack, teams, pagerduty, otlp, servicenow or jira default `"cain"`
`auth_token`	string or null	the collector's token (SIEM formats), PagerDuty integration key, ServiceNow user:password or Bearer token, Jira email:token:PROJECT, or one OTLP header 'Name: value'; stored, never returned max length `512`

Smallest valid example

{
  "url": "url",
  "format": "cain"
}

Used by 1 operation

POST /fabric/webhooks Get notified when an action is held, blocked or halted

JSON Schema

Show the raw definition

{
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 8,
      "title": "Url"
    },
    "events": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Events"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "format": {
      "type": "string",
      "title": "Format",
      "description": "cain (signed JSON envelope), splunk_hec, xsiam, datadog, sentinel, slack, teams, pagerduty, otlp, servicenow or jira",
      "default": "cain"
    },
    "auth_token": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 512
        },
        {
          "type": "null"
        }
      ],
      "title": "Auth Token",
      "description": "the collector's token (SIEM formats), PagerDuty integration key, ServiceNow user:password or Bearer token, Jira email:token:PROJECT, or one OTLP header 'Name: value'; stored, never returned"
    }
  },
  "type": "object",
  "required": [
    "url"
  ],
  "title": "WebhookRequest"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 30-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account → · Try the sandbox · See the whole ecosystem