173 lines
5.1 KiB
JSON
173 lines
5.1 KiB
JSON
{
|
|
"name": "InviteUserToSlackChannel",
|
|
"fully_qualified_name": "SlackApi.InviteUserToSlackChannel@0.1.0",
|
|
"description": "Invite users to a Slack channel.\n\nThis tool sends an invitation to specified users to join a Slack channel. It should be called when you want to add new members to a channel via an invite.",
|
|
"toolkit": {
|
|
"name": "ArcadeSlackApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "slack_channel_id",
|
|
"required": true,
|
|
"description": "The ID of the Slack channel to invite users to. It can be a public or private channel ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "channel"
|
|
},
|
|
{
|
|
"name": "user_ids_list",
|
|
"required": true,
|
|
"description": "A list of up to 100 user IDs to invite, separated by commas.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "users"
|
|
},
|
|
{
|
|
"name": "continue_with_valid_users",
|
|
"required": false,
|
|
"description": "Set to true to invite valid users while ignoring invalid IDs when multiple user IDs are provided. Default is false.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "force"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'conversations.invite'.",
|
|
"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-slack",
|
|
"provider_type": "oauth2",
|
|
"id": null,
|
|
"oauth2": {
|
|
"scopes": [
|
|
"conversations:write.invites"
|
|
]
|
|
}
|
|
},
|
|
"secrets": null,
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.0.0",
|
|
"description": "Arcade Wrapper Tools enabling LLMs to interact with low-level Slack API endpoints."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.0.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://slack.com/api/conversations.invite",
|
|
"http_method": "POST",
|
|
"headers": {
|
|
"Content-Type": "application/x-www-form-urlencoded"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "channel",
|
|
"tool_parameter_name": "slack_channel_id",
|
|
"description": "The ID of the public or private channel to invite user(s) to.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "users",
|
|
"tool_parameter_name": "user_ids_list",
|
|
"description": "A comma separated list of user IDs. Up to 100 users may be listed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "force",
|
|
"tool_parameter_name": "continue_with_valid_users",
|
|
"description": "When set to `true` and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [
|
|
"https://docs.slack.dev/reference/methods/conversations.invite"
|
|
],
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
}
|