WebhookSubscriptionRead

Fields

19 fields

breaker_threshold

integer

consecutive_failures

integer

created_at · required

string (date-time)

disabled_at

string (date-time) or null

disabled_reason

string or null

enabled · required

boolean

events · required

array of string

failure_count · required

integer

has_secret · required

boolean

id · required

string (uuid)

last_delivered_at

string (date-time) or null

last_error

string or null

last_failure_at

string (date-time) or null

max_retries · required

integer

name · required

string

project_id · required

string (uuid)

target_url · required

string

total_delivered · required

integer

updated_at · required

string (date-time)

Raw schema (JSON)

{
  "properties": {
    "breaker_threshold": {
      "default": 10,
      "title": "Breaker Threshold",
      "type": "integer"
    },
    "consecutive_failures": {
      "default": 0,
      "title": "Consecutive Failures",
      "type": "integer"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "disabled_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Disabled At"
    },
    "disabled_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Disabled Reason"
    },
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "events": {
      "items": {
        "type": "string"
      },
      "title": "Events",
      "type": "array"
    },
    "failure_count": {
      "title": "Failure Count",
      "type": "integer"
    },
    "has_secret": {
      "title": "Has Secret",
      "type": "boolean"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "last_delivered_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Delivered At"
    },
    "last_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Error"
    },
    "last_failure_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Failure At"
    },
    "max_retries": {
      "title": "Max Retries",
      "type": "integer"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "target_url": {
      "title": "Target Url",
      "type": "string"
    },
    "total_delivered": {
      "title": "Total Delivered",
      "type": "integer"
    },
    "updated_at": {
      "format": "date-time",
      "title": "Updated At",
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id",
    "name",
    "target_url",
    "events",
    "enabled",
    "has_secret",
    "max_retries",
    "failure_count",
    "total_delivered",
    "created_at",
    "updated_at"
  ],
  "title": "WebhookSubscriptionRead",
  "type": "object"
}

Used by endpoints

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

• GET /api/v1/webhooks — List Webhook Subscriptions
• POST /api/v1/webhooks — Create Webhook Subscription
• GET /api/v1/webhooks/{subscription_id} — Get 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