Hub FrameActionBody

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://neynar.com/schemas/hub/FrameActionBody",
  "title": "Hub FrameActionBody",
  "description": "Contains the data for a user's interaction with a Farcaster Frame. Frames are interactive elements within casts that can have up to 4 clickable buttons, allowing users to engage with content in predefined ways.",
  "type": "object",
  "properties": {
    "url": {
      "description": "The URL associated with the frame action. This typically points to the frame's content or the destination that handles the interaction.",
      "type": "string",
      "format": "uri",
      "example": "https://frames.farcaster.xyz/frame/123"
    },
    "buttonIndex": {
      "description": "Identifies which button the user clicked in the frame. Frames can have up to 4 buttons, numbered from 1 to 4.",
      "title": "Button Index",
      "type": "integer",
      "format": "int32",
      "minimum": 1,
      "maximum": 4,
      "example": 1
    },
    "castId": {
      "description": "The unique identifier of the cast containing the frame that was interacted with.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CastId"
        }
      ]
    }
  },
  "required": [
    "url",
    "buttonIndex",
    "castId"
  ]
}