ListenInboundEndpointResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hookbridge/main/json-schema/hookbridge-listen-inbound-endpoint-response-schema.json",
  "title": "ListenInboundEndpointResponse",
  "description": "Response from the CLI polling endpoint. Contains an array of inbound\nmessages with their full payload and headers. Use `next_cursor` to\npaginate through additional messages.\n",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/hookbridge-api-openapi.yml#/components/schemas/ListenInboundEndpointResponse",
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message_id",
          "content_type",
          "headers",
          "size_bytes",
          "received_at"
        ],
        "properties": {
          "message_id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique inbound message identifier (UUIDv7)"
          },
          "content_type": {
            "type": "string",
            "description": "Content-Type of the original inbound payload"
          },
          "headers": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "HTTP headers from the original inbound request"
          },
          "size_bytes": {
            "type": "integer",
            "description": "Payload size in bytes"
          },
          "received_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the inbound message was received"
          },
          "body": {
            "description": "Webhook payload body. JSON payloads are embedded directly as objects.\nNon-JSON payloads are base64-encoded strings (check `body_encoding`\nto distinguish). Omitted when the payload fetcher is not configured\nor the S3 key is missing.\n"
          },
          "body_encoding": {
            "type": "string",
            "enum": [
              "base64"
            ],
            "description": "Present only when body is base64-encoded (non-JSON payloads).\nOmitted for JSON payloads. Use this field to determine whether\n`body` is a raw JSON object or a base64-encoded string.\n"
          },
          "body_error": {
            "type": "string",
            "enum": [
              "payload_unavailable"
            ],
            "description": "Present only when the payload could not be fetched from storage.\nWhen set, `body` and `body_encoding` are omitted.\n"
          }
        }
      }
    },
    "meta": {
      "allOf": [
        {
          "$ref": "#/$defs/ResponseMeta"
        },
        {
          "type": "object",
          "properties": {
            "next_cursor": {
              "type": [
                "string",
                "null"
              ],
              "format": "uuid",
              "description": "Cursor for the next page of results. Pass as the `after` query\nparameter to fetch subsequent messages. Null when the response\ndata array is empty (no messages available after the cursor).\n"
            }
          }
        }
      ]
    }
  },
  "$defs": {
    "ResponseMeta": {
      "type": "object",
      "properties": {
        "request_id": {
          "type": "string",
          "description": "Unique identifier for this request (useful for support)"
        }
      }
    }
  }
}