{ "name": "AddNoteToProblem", "fully_qualified_name": "FreshserviceApi.AddNoteToProblem@1.0.0", "description": "Add a new note to a problem in Freshservice.\n\nUse this tool to create and add a new note to an existing problem in Freshservice, helping track updates or relevant information.", "toolkit": { "name": "ArcadeFreshserviceApi", "description": null, "version": "1.0.0" }, "input": { "parameters": [ { "name": "problem_id", "required": true, "description": "The ID of the problem to which the note will be added.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "ID of problem for which notes are to be retrieved" }, "inferrable": true, "http_endpoint_parameter_name": "problem_id" }, { "name": "note_html_body", "required": true, "description": "The HTML formatted content of the note to be added to the problem.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The body of the note in HTML format" }, "inferrable": true, "http_endpoint_parameter_name": "body" }, { "name": "note_unique_id", "required": false, "description": "The unique ID to be assigned to the note, ensuring it is distinct within Freshservice.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the note" }, "inferrable": true, "http_endpoint_parameter_name": "id" }, { "name": "note_creator_user_id", "required": false, "description": "The unique ID of the user creating the note. This identifies who is responsible for the note addition.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the user who created the note" }, "inferrable": true, "http_endpoint_parameter_name": "user_id" }, { "name": "notification_email_addresses", "required": false, "description": "A list of email addresses to notify about the note. Each address should be in string format.", "value_schema": { "val_type": "array", "inner_val_type": "string", "enum": null, "properties": null, "inner_properties": null, "description": "Addresses to which the note must be notified to" }, "inferrable": true, "http_endpoint_parameter_name": "notify_emails" }, { "name": "note_body_text", "required": false, "description": "The content of the note in plain text format to be added to the problem in Freshservice.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The body of the note in plain text format" }, "inferrable": true, "http_endpoint_parameter_name": "body_text" }, { "name": "note_creation_datetime", "required": false, "description": "The date and time when the note was created, formatted as a string.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Date time at which the note was created" }, "inferrable": true, "http_endpoint_parameter_name": "created_at" }, { "name": "note_updated_datetime", "required": false, "description": "The date and time when the note was last updated. Use the format 'YYYY-MM-DDTHH:MM:SSZ'.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Date time at which the note was updated" }, "inferrable": true, "http_endpoint_parameter_name": "updated_at" } ] }, "output": { "description": "Response from the API endpoint 'create-problem-note'.", "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": null, "secrets": [ { "key": "FRESHSERVICE_SUBDOMAIN" }, { "key": "FRESHSERVICE_API_KEY" } ], "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 Freshservice API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "https://{freshservice_subdomain}.freshservice.com/api/v2/problems/{problem_id}/notes", "http_method": "POST", "headers": {}, "parameters": [ { "name": "problem_id", "tool_parameter_name": "problem_id", "description": "ID of problem for which notes are to be retrieved", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "ID of problem for which notes are to be retrieved" }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "id", "tool_parameter_name": "note_unique_id", "description": "Unique ID of the note", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the note" }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "user_id", "tool_parameter_name": "note_creator_user_id", "description": "Unique ID of the user who created the note", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the user who created the note" }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "notify_emails", "tool_parameter_name": "notification_email_addresses", "description": "Addresses to which the note must be notified to", "value_schema": { "val_type": "array", "inner_val_type": "string", "enum": null, "properties": null, "inner_properties": null, "description": "Addresses to which the note must be notified to" }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "body", "tool_parameter_name": "note_html_body", "description": "The body of the note in HTML format", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The body of the note in HTML format" }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "body_text", "tool_parameter_name": "note_body_text", "description": "The body of the note in plain text format", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The body of the note in plain text format" }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "created_at", "tool_parameter_name": "note_creation_datetime", "description": "Date time at which the note was created", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Date time at which the note was created" }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "updated_at", "tool_parameter_name": "note_updated_datetime", "description": "Date time at which the note was updated", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Date time at which the note was updated" }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "FRESHSERVICE_SUBDOMAIN", "parameter_name": "freshservice_subdomain", "accepted_as": "path", "formatted_value": null, "description": "", "is_auth_token": false }, { "arcade_key": "FRESHSERVICE_API_KEY", "parameter_name": "username", "accepted_as": "basic_auth_username", "formatted_value": null, "description": "", "is_auth_token": false } ], "request_body_spec": "{\n \"description\": \"Note content of problem\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the note\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 14000345353\n },\n \"user_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the user who created the note\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 140004534\n },\n \"notify_emails\": {\n \"type\": \"array\",\n \"description\": \"Addresses to which the note must be notified to\",\n \"example\": [\n \"andrea@freshservice.com\",\n \"john.doe@freshservice.com\"\n ],\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"body\": {\n \"type\": \"string\",\n \"description\": \"The body of the note in HTML format\",\n \"example\": \"

Assigned to IT team

\"\n },\n \"body_text\": {\n \"type\": \"string\",\n \"description\": \"The body of the note in plain text format\",\n \"example\": \"Assigned to IT team\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"Date time at which the note was created\",\n \"format\": \"date_time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"Date time at which the note was updated\",\n \"format\": \"date_time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n }\n }\n }\n }\n },\n \"required\": true\n}", "use_request_body_schema_mode": false, "validate_request_body_schema": false } }