{ "name": "CreateStatusPageSubscription", "fully_qualified_name": "PagerdutyApi.CreateStatusPageSubscription@2.0.0", "description": "Subscribe to a status page by ID.\n\nUse this tool to create a subscription for a specific status page using its ID. Requires appropriate OAuth permissions.", "toolkit": { "name": "ArcadePagerdutyApi", "description": null, "version": "2.0.0" }, "input": { "parameters": [ { "name": "status_page_id", "required": true, "description": "The ID of the status page to subscribe to. This string is used to identify the specific page.", "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": "accept_header_versioning", "required": true, "description": "Specify the Accept header for API versioning when creating a status page subscription.", "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": "status_page_subscription_request", "required": false, "description": "JSON object containing subscription details: channel, contact, status page ID and type, subscribable object ID and type. Used to create a status page subscription.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "subscription": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "channel": { "val_type": "string", "inner_val_type": null, "enum": [ "webhook", "email" ], "properties": null, "inner_properties": null, "description": "The channel of the Subscription." }, "contact": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The subscriber's contact - email address or webhook URL." }, "status_page": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The id of the status page." }, "type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A string that determines the schema of the object." } }, "inner_properties": null, "description": "Status Page" }, "subscribable_object": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the subscribed entity for a given subscription." }, "type": { "val_type": "string", "inner_val_type": null, "enum": [ "status_page", "status_page_service", "status_page_post" ], "properties": null, "inner_properties": null, "description": "The type of the subscribed entity for a given subscription." } }, "inner_properties": null, "description": "The subscribed entity for a given subscription." }, "type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A string that determines the schema of the object." } }, "inner_properties": null, "description": "Request schema for creating a StatusPageSubscription." } }, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'createStatusPageSubscription'.", "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/status_pages/{id}/subscriptions", "http_method": "POST", "headers": {}, "parameters": [ { "name": "id", "tool_parameter_name": "status_page_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": "accept_header_versioning", "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": "status_page_subscription_request", "description": "", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "subscription": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "channel": { "val_type": "string", "inner_val_type": null, "enum": [ "webhook", "email" ], "properties": null, "inner_properties": null, "description": "The channel of the Subscription." }, "contact": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The subscriber's contact - email address or webhook URL." }, "status_page": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The id of the status page." }, "type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A string that determines the schema of the object." } }, "inner_properties": null, "description": "Status Page" }, "subscribable_object": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "id": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The ID of the subscribed entity for a given subscription." }, "type": { "val_type": "string", "inner_val_type": null, "enum": [ "status_page", "status_page_service", "status_page_post" ], "properties": null, "inner_properties": null, "description": "The type of the subscribed entity for a given subscription." } }, "inner_properties": null, "description": "The subscribed entity for a given subscription." }, "type": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A string that determines the schema of the object." } }, "inner_properties": null, "description": "Request schema for creating a StatusPageSubscription." } }, "inner_properties": null, "description": "" }, "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 \"subscription\": {\n \"type\": \"object\",\n \"title\": \"StatusPageSubscriptionRequest\",\n \"description\": \"Request schema for creating a StatusPageSubscription.\",\n \"properties\": {\n \"channel\": {\n \"description\": \"The channel of the Subscription.\",\n \"enum\": [\n \"webhook\",\n \"email\"\n ],\n \"nullable\": false,\n \"title\": \"SubscriptionChannel\",\n \"type\": \"string\"\n },\n \"contact\": {\n \"description\": \"The subscriber's contact - email address or webhook URL.\",\n \"type\": \"string\",\n \"nullable\": false\n },\n \"status_page\": {\n \"description\": \"Status Page\",\n \"nullable\": false,\n \"properties\": {\n \"id\": {\n \"description\": \"The id of the status page.\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"A string that determines the schema of the object.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"id\"\n ],\n \"type\": \"object\"\n },\n \"subscribable_object\": {\n \"type\": \"object\",\n \"title\": \"SubscribableObject\",\n \"description\": \"The subscribed entity for a given subscription.\",\n \"properties\": {\n \"id\": {\n \"description\": \"The ID of the subscribed entity for a given subscription.\",\n \"type\": \"string\",\n \"nullable\": false\n },\n \"type\": {\n \"description\": \"The type of the subscribed entity for a given subscription.\",\n \"enum\": [\n \"status_page\",\n \"status_page_service\",\n \"status_page_post\"\n ],\n \"type\": \"string\",\n \"nullable\": false\n }\n }\n },\n \"type\": {\n \"description\": \"A string that determines the schema of the object.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"channel\",\n \"contact\",\n \"subscribable_object\",\n \"status_page\",\n \"type\"\n ]\n }\n },\n \"required\": [\n \"subscription\"\n ]\n },\n \"example\": {\n \"subscription\": {\n \"channel\": \"email\",\n \"contact\": \"joe@email.example\",\n \"status_page\": {\n \"id\": \"PIJ90N7\",\n \"type\": \"status_page\"\n },\n \"subscribable_object\": {\n \"id\": \"PSX4LJI\",\n \"type\": \"status_page_service\"\n },\n \"type\": \"status_page_subscription\"\n }\n }\n }\n }\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }