Delivery

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/placestack-com/json-schema/placestack-com-delivery-schema.json",
  "title": "Delivery",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/placestack-com-openapi.json#/components/schemas/Delivery",
  "properties": {
    "object": {
      "type": "string",
      "const": "webhook_delivery",
      "title": "Object",
      "description": "The object's type. Always `webhook_delivery`.",
      "default": "webhook_delivery"
    },
    "id": {
      "type": "string",
      "pattern": "^whd_[0-7][0-9a-hjkmnp-tv-z]{25}$",
      "title": "Id",
      "description": "Unique identifier for the object. Also sent as the `webhook-id` header. A delivery can arrive more than once, so deduplicate on it."
    },
    "seq": {
      "type": "integer",
      "title": "Seq",
      "description": "The delivery's position in the webhook's log. Use as `since`."
    },
    "event_type": {
      "type": "string",
      "enum": [
        "permit.created",
        "case.created"
      ],
      "title": "Event Type",
      "description": "The event type."
    },
    "synthetic": {
      "type": "boolean",
      "title": "Synthetic",
      "description": "Whether this is a test delivery."
    },
    "subject": {
      "type": "string",
      "title": "Subject",
      "description": "The id of the object the event is about."
    },
    "body": {
      "additionalProperties": true,
      "type": "object",
      "title": "Body",
      "description": "The JSON body, as signed."
    },
    "body_sha256": {
      "type": "string",
      "title": "Body Sha256",
      "description": "The SHA-256 hash of the body, in hex."
    },
    "state": {
      "type": "string",
      "enum": [
        "pending",
        "delivered",
        "failed",
        "dead_lettered"
      ],
      "title": "State",
      "description": "One of `pending`, `delivered`, `failed` or `dead_lettered`. `failed` has retries remaining."
    },
    "attempt_count": {
      "type": "integer",
      "title": "Attempt Count",
      "description": "Attempts made so far."
    },
    "next_attempt_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Attempt At",
      "description": "Time of the next attempt. Null unless `state` is `pending` or `failed`."
    },
    "delivered_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Delivered At",
      "description": "Time at which the delivery succeeded. Null until it does."
    },
    "dead_lettered_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dead Lettered At",
      "description": "Time at which retries stopped. Null unless `state` is `dead_lettered`."
    },
    "response_status": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Response Status",
      "description": "The last attempt's HTTP status. Null when it got no response."
    },
    "response_body_head": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Response Body Head",
      "description": "The first kilobyte of the last attempt's response body. Null when it got no response."
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error",
      "description": "The last attempt's connection error. Null when it got a response."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created At",
      "description": "Time at which the object was created."
    },
    "attempt": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/DeliveryAttempt"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Attempt",
      "description": "Every attempt, oldest first. Only on `GET /webhook/{webhook}/delivery/{delivery}`; null in a list."
    }
  },
  "type": "object",
  "required": [
    "object",
    "id",
    "seq",
    "event_type",
    "synthetic",
    "subject",
    "body",
    "body_sha256",
    "state",
    "attempt_count",
    "next_attempt_at",
    "delivered_at",
    "dead_lettered_at",
    "response_status",
    "response_body_head",
    "error",
    "created_at",
    "attempt"
  ],
  "$defs": {
    "DeliveryAttempt": {
      "properties": {
        "attempt": {
          "type": "integer",
          "title": "Attempt",
          "description": "The attempt's number, starting at 1."
        },
        "attempted_at": {
          "type": "string",
          "format": "date-time",
          "title": "Attempted At",
          "description": "Time at which the attempt was made."
        },
        "duration_ms": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Duration Ms",
          "description": "Time until the response, in milliseconds. Null when there was no response."
        },
        "timestamp": {
          "type": "integer",
          "title": "Timestamp",
          "description": "The `webhook-timestamp` header sent."
        },
        "signature": {
          "type": "string",
          "title": "Signature",
          "description": "The `webhook-signature` header sent."
        },
        "response_status": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Response Status",
          "description": "The response's HTTP status. Null when there was no response."
        },
        "response_body_head": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Response Body Head",
          "description": "The first kilobyte of the response body. Null when there was no response."
        },
        "error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Error",
          "description": "The connection error. Null when there was a response."
        }
      },
      "type": "object",
      "required": [
        "attempt",
        "attempted_at",
        "timestamp",
        "signature"
      ],
      "title": "DeliveryAttempt",
      "description": "One attempt to deliver an event."
    }
  }
}