Delivery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/thread-page/json-schema/thread-page-delivery-schema.json",
  "title": "Delivery",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thread-page-openapi.json#/components/schemas/Delivery",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "event_id": {
      "type": "string"
    },
    "event_type": {
      "$ref": "#/$defs/SentEventTypeEnum"
    },
    "test": {
      "type": "boolean",
      "description": "The owner's test (Send test): a made-up event with data.test true, sent once; never retried and never counted as the webhook's delivery."
    },
    "thread_title": {
      "type": [
        "string",
        "null"
      ],
      "description": "Shown to the owner; always null through the Integration API."
    },
    "attempt": {
      "type": "integer"
    },
    "status": {
      "$ref": "#/$defs/DeliveryStatusEnum"
    },
    "http_status": {
      "type": [
        "integer",
        "null"
      ]
    },
    "error": {
      "type": [
        "string",
        "null"
      ],
      "description": "Why the attempt failed: timeout (no complete answer within 15 seconds), tls (the endpoint's certificate is not trusted or not valid), network, protocol, http, redirect, refused, gone, too_large, expired, content_removed, secret_unavailable, not_allowed (the connection may no longer read the event), interrupted (the worker stopped mid-attempt), or a host it may not reach: the Integration API says not_allowed_host, the owner's Settings unresolved or blocked_address."
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time"
    },
    "finished_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "retryable": {
      "type": "boolean"
    }
  },
  "required": [
    "attempt",
    "error",
    "event_id",
    "event_type",
    "finished_at",
    "http_status",
    "id",
    "retryable",
    "scheduled_at",
    "status",
    "test",
    "thread_title"
  ],
  "$defs": {
    "DeliveryStatusEnum": {
      "enum": [
        "pending",
        "delivered",
        "failed",
        "abandoned"
      ],
      "type": "string",
      "description": "* `pending` - pending\n* `delivered` - delivered\n* `failed` - failed\n* `abandoned` - abandoned"
    },
    "SentEventTypeEnum": {
      "enum": [
        "note.created",
        "note.updated",
        "note.trashed",
        "note.restored",
        "note.moved",
        "note.purged",
        "thread.created",
        "thread.renamed",
        "thread.updated",
        "thread.statuses_changed",
        "thread.archived",
        "thread.unarchived",
        "thread.moved",
        "thread.trashed",
        "thread.restored",
        "thread.purged",
        "folder.created",
        "folder.renamed",
        "folder.moved",
        "folder.trashed",
        "folder.restored",
        "folder.purged",
        "import.completed",
        "reminder.set",
        "reminder.changed",
        "reminder.removed",
        "request.created",
        "request.cancelled"
      ],
      "type": "string",
      "description": "* `note.created` - note.created\n* `note.updated` - note.updated\n* `note.trashed` - note.trashed\n* `note.restored` - note.restored\n* `note.moved` - note.moved\n* `note.purged` - note.purged\n* `thread.created` - thread.created\n* `thread.renamed` - thread.renamed\n* `thread.updated` - thread.updated\n* `thread.statuses_changed` - thread.statuses_changed\n* `thread.archived` - thread.archived\n* `thread.unarchived` - thread.unarchived\n* `thread.moved` - thread.moved\n* `thread.trashed` - thread.trashed\n* `thread.restored` - thread.restored\n* `thread.purged` - thread.purged\n* `folder.created` - folder.created\n* `folder.renamed` - folder.renamed\n* `folder.moved` - folder.moved\n* `folder.trashed` - folder.trashed\n* `folder.restored` - folder.restored\n* `folder.purged` - folder.purged\n* `import.completed` - import.completed\n* `reminder.set` - reminder.set\n* `reminder.changed` - reminder.changed\n* `reminder.removed` - reminder.removed\n* `request.created` - request.created\n* `request.cancelled` - request.cancelled"
    }
  }
}