WebhookDeliveryRead

Fields

11 fields

attempt_count · required

integer

created_at · required

string (date-time)

delivered_at

string (date-time) or null

error

string or null

event_payload

object or null

event_type · required

string

http_status

integer or null

id · required

string (uuid)

response_preview

string or null

status · required

string

subscription_id · required

string (uuid)

Raw schema (JSON)

{
  "properties": {
    "attempt_count": {
      "title": "Attempt Count",
      "type": "integer"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "delivered_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Delivered At"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error"
    },
    "event_payload": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Event Payload"
    },
    "event_type": {
      "title": "Event Type",
      "type": "string"
    },
    "http_status": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Http Status"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "response_preview": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Response Preview"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "subscription_id": {
      "format": "uuid",
      "title": "Subscription Id",
      "type": "string"
    }
  },
  "required": [
    "id",
    "subscription_id",
    "event_type",
    "status",
    "attempt_count",
    "created_at"
  ],
  "title": "WebhookDeliveryRead",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• GET /api/v1/webhooks/{subscription_id}/deliveries — List Webhook Deliveries

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON