Subscription

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/thread-page/json-schema/thread-page-subscription-schema.json",
  "title": "Subscription",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/thread-page-openapi.json#/components/schemas/Subscription",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "kind": {
      "$ref": "#/$defs/SubscriptionKindEnum"
    },
    "endpoint": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri"
    },
    "endpoint_host": {
      "type": [
        "string",
        "null"
      ]
    },
    "event_types": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EventTypeEnum"
      }
    },
    "origins": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EventOriginEnum"
      }
    },
    "payload_mode": {
      "$ref": "#/$defs/PayloadModeEnum"
    },
    "state": {
      "$ref": "#/$defs/SubscriptionStateEnum"
    },
    "state_reason": {
      "description": "rate: the account's webhooks reached the day's deliveries; they resume on their own after midnight UTC.\n\n* `owner` - owner\n* `connection` - connection\n* `endpoint_auth` - endpoint_auth\n* `endpoint_gone` - endpoint_gone\n* `secret_unavailable` - secret_unavailable\n* `token_retired` - token_retired\n* `rate` - rate",
      "oneOf": [
        {
          "$ref": "#/$defs/StateReasonEnum"
        },
        {
          "$ref": "#/$defs/NullEnum"
        }
      ]
    },
    "added_by": {
      "allOf": [
        {
          "$ref": "#/$defs/AddedByEnum"
        }
      ],
      "description": "token: added through the Integration API with the current token, and paused when it is replaced; earlier_token: added with a token since replaced.\n\n* `owner` - owner\n* `token` - token\n* `earlier_token` - earlier_token"
    },
    "needs_attention": {
      "type": "boolean"
    },
    "retrying": {
      "type": "boolean",
      "description": "A failed delivery is waiting for its automatic retry."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "last_delivery": {
      "oneOf": [
        {
          "$ref": "#/$defs/LastDelivery"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "added_by",
    "created_at",
    "endpoint",
    "endpoint_host",
    "event_types",
    "id",
    "kind",
    "last_delivery",
    "needs_attention",
    "origins",
    "payload_mode",
    "retrying",
    "state",
    "state_reason"
  ],
  "$defs": {
    "AddedByEnum": {
      "enum": [
        "owner",
        "token",
        "earlier_token"
      ],
      "type": "string",
      "description": "* `owner` - owner\n* `token` - token\n* `earlier_token` - earlier_token"
    },
    "EventOriginEnum": {
      "enum": [
        "human",
        "service",
        "agent",
        "participant"
      ],
      "type": "string",
      "description": "* `human` - human\n* `service` - service\n* `agent` - agent\n* `participant` - participant"
    },
    "EventTypeEnum": {
      "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"
      ],
      "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"
    },
    "LastDelivery": {
      "type": "object",
      "properties": {
        "status": {
          "$ref": "#/$defs/LastDeliveryStatusEnum"
        },
        "http_status": {
          "type": [
            "integer",
            "null"
          ]
        },
        "at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "at",
        "http_status",
        "status"
      ]
    },
    "LastDeliveryStatusEnum": {
      "enum": [
        "delivered",
        "failed",
        "abandoned"
      ],
      "type": "string",
      "description": "* `delivered` - delivered\n* `failed` - failed\n* `abandoned` - abandoned"
    },
    "NullEnum": {
      "type": "null"
    },
    "PayloadModeEnum": {
      "enum": [
        "content",
        "ids"
      ],
      "type": "string",
      "description": "* `content` - content\n* `ids` - ids"
    },
    "StateReasonEnum": {
      "enum": [
        "owner",
        "connection",
        "endpoint_auth",
        "endpoint_gone",
        "secret_unavailable",
        "token_retired",
        "rate"
      ],
      "type": "string",
      "description": "* `owner` - owner\n* `connection` - connection\n* `endpoint_auth` - endpoint_auth\n* `endpoint_gone` - endpoint_gone\n* `secret_unavailable` - secret_unavailable\n* `token_retired` - token_retired\n* `rate` - rate"
    },
    "SubscriptionKindEnum": {
      "enum": [
        "webhook",
        "pull"
      ],
      "type": "string",
      "description": "* `webhook` - webhook\n* `pull` - pull"
    },
    "SubscriptionStateEnum": {
      "enum": [
        "ready",
        "paused",
        "expired"
      ],
      "type": "string",
      "description": "* `ready` - ready\n* `paused` - paused\n* `expired` - expired"
    }
  }
}