{ "name": "CreateOnboardingRequest", "fully_qualified_name": "FreshserviceApi.CreateOnboardingRequest@1.0.0", "description": "Create a new onboarding request in Freshservice.\n\nUse this tool to initiate a new employee onboarding process in Freshservice. It should be called when a new hire needs to be onboarded, capturing all necessary details and confirming the creation of the request.", "toolkit": { "name": "ArcadeFreshserviceApi", "description": null, "version": "1.0.0" }, "input": { "parameters": [ { "name": "onboarding_request_details", "required": false, "description": "JSON containing required details for the new onboarding request, such as employee information and start date.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "fields": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "inner_properties": null, "description": "onboarding request that needs to be created" }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'create-onboarding-request'.", "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/onboarding_requests", "http_method": "POST", "headers": {}, "parameters": [ { "name": "requestBody", "tool_parameter_name": "onboarding_request_details", "description": "onboarding request that needs to be created", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "fields": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "inner_properties": null, "description": "onboarding request that needs to be created" }, "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\": \"onboarding request that needs to be created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"fields\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"fields\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\"\n },\n \"example\": {\n \"cf_employee_name\": \"Sample\",\n \"cf_department_name\": \"Customer Support\",\n \"cf_job_title\": \"it user\",\n \"cf_date_of_joining\": \"2019-06-15\"\n }\n }\n }\n }\n }\n },\n \"required\": false\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }