Table of Contents
Actiondesk is spreadsheet software natively integrated with your business apps and data sources. No more CSV-copy-pasting. Import data from SQL, Stripe, Salesforce, Hubspot, and more.
API Overview
Actiondesk is a cloud-based help desk and customer support software designed to streamline support operations and enhance customer satisfaction. It provides a comprehensive suite of features, including ticketing, knowledge base management, live chat, and reporting. Actiondesk's intuitive interface and customizable workflows empower support teams to resolve customer inquiries efficiently and effectively. With its robust automation capabilities, Actiondesk automates repetitive tasks, freeing up agents to focus on complex issues and provide personalized support.
Actiondesk API offers a comprehensive set of REST APIs that enable developers to integrate Actiondesk functionality into their applications. The API documentation provides clear and detailed instructions on how to use the various endpoints and includes code samples for different programming languages. The REST APIs allow developers to perform a wide range of operations, such as creating and managing tickets, updating customer information, and retrieving support metrics. Actiondesk also supports webhooks, which allow developers to receive real-time notifications when specific events occur within the system. To ensure optimal performance and prevent abuse, Actiondesk enforces rate limits on API requests, ensuring that the system remains responsive and stable for all users.
API Request Limits
Free
100 requests per minute
Pro
1,000 requests per minute
Business
5,000 requests per minute
Enterprise
10,000 requests per minute
SDKs
APIs
Method: get
Description: Get a list of all accounts..
Endpoint: accounts
Parameters:
Method: post
Description: Creates a new account..
Endpoint: accounts
Parameters: account_name, password, timezone, plan
Method: get
Description: Get a specific account..
Endpoint: accounts/{account_id}
Parameters: account_id
Method: patch
Description: Updates an account..
Endpoint: accounts/{account_id}
Parameters: account_id, account_name, password, timezone, plan
Method: delete
Description: Deletes an account..
Endpoint: accounts/{account_id}
Parameters: account_id
Method: get
Description: Get a list of all users in an account..
Endpoint: accounts/{account_id}/users
Parameters: account_id
Method: post
Description: Creates a new user..
Endpoint: accounts/{account_id}/users
Parameters: account_id, user_name, email, password, role
Method: get
Description: Get a specific user in an account..
Endpoint: accounts/{account_id}/users/{user_id}
Parameters: account_id, user_id
Method: patch
Description: Updates a user..
Endpoint: accounts/{account_id}/users/{user_id}
Parameters: account_id, user_id, user_name, email, password, role
Method: delete
Description: Deletes a user..
Endpoint: accounts/{account_id}/users/{user_id}
Parameters: account_id, user_id
Method: get
Description: Get a list of all applications..
Endpoint: applications
Parameters:
Method: post
Description: Creates a new application..
Endpoint: applications
Parameters: application_name, description, category, logo_url, git_url, git_branch, build_command, deploy_command, auto_deploy
Method: get
Description: Get a specific application..
Endpoint: applications/{application_id}
Parameters: application_id
Method: patch
Description: Updates an application..
Endpoint: applications/{application_id}
Parameters: application_id, application_name, description, category, logo_url, git_url, git_branch, build_command, deploy_command, auto_deploy
Method: delete
Description: Deletes an application..
Endpoint: applications/{application_id}
Parameters: application_id
Method: post
Description: Builds an application..
Endpoint: applications/{application_id}/build
Parameters: application_id
Method: post
Description: Deploys an application..
Endpoint: applications/{application_id}/deploy
Parameters: application_id
Method: get
Description: Get a list of all environments for an application..
Endpoint: applications/{application_id}/environments
Parameters: application_id
Method: post
Description: Creates a new environment..
Endpoint: environments
Parameters: environment_name, type, application_id, description, production
Method: get
Description: Get a specific environment..
Endpoint: environments/{environment_id}
Parameters: environment_id
Method: patch
Description: Updates an environment..
Endpoint: environments/{environment_id}
Parameters: environment_id, environment_name, type, application_id, description, production
Method: delete
Description: Deletes an environment..
Endpoint: environments/{environment_id}
Parameters: environment_id
Method: get
Description: Get a list of all domains for an environment..
Endpoint: environments/{environment_id}/domain_mappings
Parameters: environment_id
Method: post
Description: Creates a new domain..
Endpoint: domains
Parameters: domain_name, environment_id
Method: get
Description: Get a specific domain..
Endpoint: domains/{domain_id}
Parameters: domain_id
Method: patch
Description: Updates a domain..
Endpoint: domains/{domain_id}
Parameters: domain_id, domain_name, environment_id
Method: delete
Description: Deletes a domain..
Endpoint: domains/{domain_id}
Parameters: domain_id
Method: get
Description: Get a list of all services..
Endpoint: services
Parameters:
Method: post
Description: Creates a new service..
Endpoint: services
Parameters: service_name, image_name, description, entrypoint, ports, labels, environment_variables, health_check, secrets, mount_paths, volume_mounts
Method: get
Description: Get a specific service..
Endpoint: services/{service_id}
Parameters: service_id
Method: patch
Description: Updates a service..
Endpoint: services/{service_id}
Parameters: service_id, service_name, image_name, description, entrypoint, ports, labels, environment_variables, health_check, secrets, mount_paths, volume_mounts
Method: delete
Description: Deletes a service..
Endpoint: services/{service_id}
Parameters: service_id
Method: get
Description: Get a list of all workflows..
Endpoint: workflows
Parameters:
Method: post
Description: Creates a new workflow..
Endpoint: workflows
Parameters: workflow_name, description, triggers, actions
Method: get
Description: Get a specific workflow..
Endpoint: workflows/{workflow_id}
Parameters: workflow_id
Method: patch
Description: Updates a workflow..
Endpoint: workflows/{workflow_id}
Parameters: workflow_id, workflow_name, description, triggers, actions
Method: delete
Description: Deletes a workflow..
Endpoint: workflows/{workflow_id}
Parameters: workflow_id
Method: get
Description: Get a list of all triggers..
Endpoint: triggers
Parameters:
Method: post
Description: Creates a new trigger..
Endpoint: triggers
Parameters: trigger_name, description, type, schedule, payload, workflow_id
Method: get
Description: Get a specific trigger..
Endpoint: triggers/{trigger_id}
Parameters: trigger_id
Method: patch
Description: Updates a trigger..
Endpoint: triggers/{trigger_id}
Parameters: trigger_id, trigger_name, description, type, schedule, payload, workflow_id
Method: delete
Description: Deletes a trigger..
Endpoint: triggers/{trigger_id}
Parameters: trigger_id
Method: get
Description: Get a list of all actions..
Endpoint: actions
Parameters:
Method: post
Description: Creates a new action..
Endpoint: actions
Parameters: action_name, description, type, command, script, http_request, workflow_id
Method: get
Description: Get a specific action..
Endpoint: actions/{action_id}
Parameters: action_id
Method: patch
Description: Updates an action..
Endpoint: actions/{action_id}
Parameters: action_id, action_name, description, type, command, script, http_request, workflow_id
Method: delete
Description: Deletes an action..
Endpoint: actions/{action_id}
Parameters: action_id
FAQ
How do I authenticate with the Actiondesk API using Java?
You can authenticate using the Actiondesk Java SDK. Create a ServiceAccountCredentials object using your service account key file. Then, use the credentials object to create an Actiondesk object.
What is the rate limit for the Actiondesk API?
The rate limit for the Actiondesk API is 100 requests per second per project. This limit applies to all API methods.
How do I create a sandbox account?
You can create a sandbox account by signing up for a free trial at https://actiondesk.io/signup. Sandbox accounts have a limited number of features, but they are a good way to test the API before upgrading to a paid account.
How do I get support for the Actiondesk API?
You can contact Actiondesk support by emailing support@actiondesk.io. The support team is available 24/7 to help with any questions or issues you may have.
What is the difference between a developer account and a production account?
A developer account is a free account that gives you access to the Actiondesk API for development and testing purposes. A production account is a paid account that gives you access to all of the features of the API.