WebhookSubscriptionWrite

Fields

7 fields

breaker_threshold

integer or null

enabled

boolean

events · required

array of string

max_retries

integer

name · required

string

secret

string or null

target_url · required

string

Raw schema (JSON)

{
  "properties": {
    "breaker_threshold": {
      "anyOf": [
        {
          "maximum": 100,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Breaker Threshold"
    },
    "enabled": {
      "default": true,
      "title": "Enabled",
      "type": "boolean"
    },
    "events": {
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "title": "Events",
      "type": "array"
    },
    "max_retries": {
      "default": 5,
      "maximum": 10,
      "minimum": 0,
      "title": "Max Retries",
      "type": "integer"
    },
    "name": {
      "maxLength": 255,
      "minLength": 1,
      "title": "Name",
      "type": "string"
    },
    "secret": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Secret"
    },
    "target_url": {
      "maxLength": 1000,
      "minLength": 8,
      "pattern": "^https?://",
      "title": "Target Url",
      "type": "string"
    }
  },
  "required": [
    "name",
    "target_url",
    "events"
  ],
  "title": "WebhookSubscriptionWrite",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/webhooks — Create Webhook Subscription
• PATCH /api/v1/webhooks/{subscription_id} — Update Webhook Subscription

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON