arcade-mcp/toolkits/pagerduty_api/arcade_pagerduty_api/wrapper_tools/SubscribeBusinessServiceEntities.json

{
  "name": "SubscribeBusinessServiceEntities",
  "fully_qualified_name": "PagerdutyApi.SubscribeBusinessServiceEntities@2.0.0",
  "description": "Subscribe entities to a specified business service.\n\nThis tool subscribes specified entities to a business service, allowing them to receive notifications. It should be called when you need to add entities to the notification list for a business service.",
  "toolkit": {
    "name": "ArcadePagerdutyApi",
    "description": null,
    "version": "2.0.0"
  },
  "input": {
    "parameters": [
      {
        "name": "resource_id",
        "required": true,
        "description": "The unique identifier of the business service to which entities will be subscribed.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the resource."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "id"
      },
      {
        "name": "use_versioning_header",
        "required": true,
        "description": "The API versioning header to specify the desired response format version.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The `Accept` header is used as a versioning header."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "Accept"
      },
      {
        "name": "entities_to_subscribe",
        "required": false,
        "description": "JSON object containing entities (user or team) to subscribe, each with an ID and type.",
        "value_schema": {
          "val_type": "json",
          "inner_val_type": null,
          "enum": null,
          "properties": {
            "subscribers": {
              "val_type": "array",
              "inner_val_type": "json",
              "enum": null,
              "properties": null,
              "inner_properties": {
                "subscriber_id": {
                  "val_type": "string",
                  "inner_val_type": null,
                  "enum": null,
                  "properties": null,
                  "inner_properties": null,
                  "description": "The ID of the entity being subscribed"
                },
                "subscriber_type": {
                  "val_type": "string",
                  "inner_val_type": null,
                  "enum": [
                    "user",
                    "team"
                  ],
                  "properties": null,
                  "inner_properties": null,
                  "description": "The type of the entity being subscribed"
                }
              },
              "description": null
            }
          },
          "inner_properties": null,
          "description": "The entities to subscribe."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "requestBody"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'createBusinessServiceNotificationSubscribers'.",
    "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-pagerduty",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the Pagerduty API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "https://api.pagerduty.com/business_services/{id}/subscribers",
    "http_method": "POST",
    "headers": {},
    "parameters": [
      {
        "name": "id",
        "tool_parameter_name": "resource_id",
        "description": "The ID of the resource.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The ID of the resource."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "Accept",
        "tool_parameter_name": "use_versioning_header",
        "description": "The `Accept` header is used as a versioning header.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The `Accept` header is used as a versioning header."
        },
        "accepted_as": "header",
        "required": true,
        "deprecated": false,
        "default": "application/vnd.pagerduty+json;version=2",
        "documentation_urls": []
      },
      {
        "name": "requestBody",
        "tool_parameter_name": "entities_to_subscribe",
        "description": "The entities to subscribe.",
        "value_schema": {
          "val_type": "json",
          "inner_val_type": null,
          "enum": null,
          "properties": {
            "subscribers": {
              "val_type": "array",
              "inner_val_type": "json",
              "enum": null,
              "properties": null,
              "inner_properties": {
                "subscriber_id": {
                  "val_type": "string",
                  "inner_val_type": null,
                  "enum": null,
                  "properties": null,
                  "inner_properties": null,
                  "description": "The ID of the entity being subscribed"
                },
                "subscriber_type": {
                  "val_type": "string",
                  "inner_val_type": null,
                  "enum": [
                    "user",
                    "team"
                  ],
                  "properties": null,
                  "inner_properties": null,
                  "description": "The type of the entity being subscribed"
                }
              },
              "description": null
            }
          },
          "inner_properties": null,
          "description": "The entities to subscribe."
        },
        "accepted_as": "body",
        "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": "{\n  \"content\": {\n    \"application/json\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"subscribers\": {\n            \"type\": \"array\",\n            \"uniqueItems\": true,\n            \"minItems\": 1,\n            \"items\": {\n              \"title\": \"NotificationSubscriber\",\n              \"description\": \"A reference of a subscriber entity.\",\n              \"type\": \"object\",\n              \"properties\": {\n                \"subscriber_id\": {\n                  \"type\": \"string\",\n                  \"description\": \"The ID of the entity being subscribed\"\n                },\n                \"subscriber_type\": {\n                  \"type\": \"string\",\n                  \"description\": \"The type of the entity being subscribed\",\n                  \"enum\": [\n                    \"user\",\n                    \"team\"\n                  ]\n                }\n              },\n              \"example\": {\n                \"subscriber_id\": \"PD1234\",\n                \"subscriber_type\": \"user\"\n              }\n            }\n          }\n        },\n        \"required\": [\n          \"subscribers\"\n        ]\n      },\n      \"examples\": {\n        \"request\": {\n          \"summary\": \"Request Example\",\n          \"value\": {\n            \"subscribers\": [\n              {\n                \"subscriber_id\": \"PD1234\",\n                \"subscriber_type\": \"team\"\n              },\n              {\n                \"subscriber_id\": \"PD1235\",\n                \"subscriber_type\": \"team\"\n              },\n              {\n                \"subscriber_id\": \"PD1234\",\n                \"subscriber_type\": \"user\"\n              }\n            ]\n          }\n        }\n      }\n    }\n  },\n  \"description\": \"The entities to subscribe.\"\n}",
    "use_request_body_schema_mode": true,
    "validate_request_body_schema": true
  }
}