WebhookResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pricklymails-com/json-schema/pricklymails-com-webhook-response-schema.json",
  "title": "WebhookResponse",
  "description": "Metadata of a webhook endpoint, returned when listing, reading or updating endpoints.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pricklymails-com-openapi.json#/components/schemas/WebhookResponse",
  "type": "object",
  "required": [
    "uuid",
    "url",
    "events",
    "status",
    "total_deliveries",
    "successful_deliveries",
    "consecutive_failures",
    "created_at"
  ],
  "properties": {
    "consecutive_failures": {
      "type": "integer",
      "format": "int32",
      "description": "Number of failed deliveries in a row since the last success.",
      "minimum": 0
    },
    "created_at": {
      "type": "string",
      "description": "RFC 3339 creation timestamp."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description of the endpoint, omitted when none was set."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Events the endpoint is subscribed to."
    },
    "last_delivery_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "RFC 3339 timestamp of the last delivery, omitted when there was none."
    },
    "status": {
      "type": "string",
      "description": "Status of the endpoint: `\"active\"`, `\"paused\"` or `\"disabled\"`."
    },
    "successful_deliveries": {
      "type": "integer",
      "format": "int64",
      "description": "Number of deliveries the endpoint acknowledged with a 2xx status.",
      "minimum": 0
    },
    "total_deliveries": {
      "type": "integer",
      "format": "int64",
      "description": "Number of deliveries attempted.",
      "minimum": 0
    },
    "url": {
      "type": "string",
      "description": "URL that receives the notifications."
    },
    "uuid": {
      "type": "string",
      "description": "Public UUID of the endpoint."
    }
  }
}