arcade-mcp/toolkits/figma_api/arcade_figma_api/wrapper_tools/GetFigmaWebhooks.json

{
  "name": "GetFigmaWebhooks",
  "fully_qualified_name": "FigmaApi.GetFigmaWebhooks@0.1.0",
  "description": "Retrieve a list of webhooks from Figma.\n\nCall this tool to get a list of webhooks available in your Figma context or plan. This can be used to manage and view all the webhooks you have access to, with results provided in a paginated format.",
  "toolkit": {
    "name": "ArcadeFigmaApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "webhook_context",
        "required": false,
        "description": "Specify the context for the webhooks. Accepts 'team', 'project', or 'file'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Context to create the resource on. Should be \"team\", \"project\", or \"file\"."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "context"
      },
      {
        "name": "context_identifier",
        "required": false,
        "description": "The ID of the context to fetch attached webhooks. Cannot be used with plan_api_id.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The id of the context that you want to get attached webhooks for. If you're using context_id, you cannot use plan_api_id."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "context_id"
      },
      {
        "name": "plan_id_for_webhooks",
        "required": false,
        "description": "The ID of your plan for retrieving webhooks across all accessible contexts. Cannot be used with context or context_id.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The id of your plan. Use this to get all webhooks for all contexts you have access to. If you're using plan_api_id, you cannot use context or context_id. When you use plan_api_id, the response is paginated."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "plan_api_id"
      },
      {
        "name": "pagination_cursor",
        "required": false,
        "description": "Cursor for pagination when using plan_api_id. Provide next_page or prev_page from previous response to navigate pages.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "If you're using plan_api_id, this is the cursor to use for pagination. If you're using context or context_id, this parameter is ignored. Provide the next_page or prev_page value from the previous response to get the next or previous page of results."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "cursor"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getWebhooks'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-figma",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": {
        "scopes": [
          "webhooks:read"
        ]
      }
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.0.0",
    "description": "Tools that enable LLMs to interact directly with the figma API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.1.0",
      "description": ""
    },
    "url": "https://api.figma.com/v2/webhooks",
    "http_method": "GET",
    "headers": {
      "Content-Type": "application/json"
    },
    "parameters": [
      {
        "name": "context",
        "tool_parameter_name": "webhook_context",
        "description": "Context to create the resource on. Should be \"team\", \"project\", or \"file\".",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Context to create the resource on. Should be \"team\", \"project\", or \"file\"."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "context_id",
        "tool_parameter_name": "context_identifier",
        "description": "The id of the context that you want to get attached webhooks for. If you're using context_id, you cannot use plan_api_id.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The id of the context that you want to get attached webhooks for. If you're using context_id, you cannot use plan_api_id."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "plan_api_id",
        "tool_parameter_name": "plan_id_for_webhooks",
        "description": "The id of your plan. Use this to get all webhooks for all contexts you have access to. If you're using plan_api_id, you cannot use context or context_id. When you use plan_api_id, the response is paginated.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The id of your plan. Use this to get all webhooks for all contexts you have access to. If you're using plan_api_id, you cannot use context or context_id. When you use plan_api_id, the response is paginated."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "cursor",
        "tool_parameter_name": "pagination_cursor",
        "description": "If you're using plan_api_id, this is the cursor to use for pagination. If you're using context or context_id, this parameter is ignored. Provide the next_page or prev_page value from the previous response to get the next or previous page of results.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "If you're using plan_api_id, this is the cursor to use for pagination. If you're using context or context_id, this parameter is ignored. Provide the next_page or prev_page value from the previous response to get the next or previous page of results."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": null,
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}