ConnectWise Manage API Essential Guide

What type of API does ConnectWise Manage provide?

REST API

• REST is described as "the cornerstone of ConnectWise Asio API architecture"
• Almost all ConnectWise services use REST as their public-facing API
• REST is chosen due to being the most common and easily understood standard, with comprehensive tooling like OpenAPI (Swagger)

Other API Types

• GraphQL is used within Asio to address challenges like efficient data retrieval from multiple sources and data integration
• gRPC is used for efficient internal service communication in critical areas
• WebSockets are used for real-time UI push notifications
• Webhooks are used to allow safe third-party access to event streams

Key Considerations

• REST APIs are widely supported and good for web/mobile applications
• They use JSON or XML as the data format
• REST is based on resources and HTTP methods

Summary

ConnectWise Manage primarily offers a REST API for external integrations and public-facing services. While they use other API types internally for specific purposes, the main API that developers and partners would interact with is REST-based. This aligns with industry standards and provides good compatibility for most integration scenarios.

Does the ConnectWise Manage API have webhooks?

1. The official ConnectWise Manage API does support webhooks.

2. ConnectWise provides webhooks documentation that outlines the currently available webhooks.

3. Webhooks can be configured through the UI or via API calls to the /instances endpoint.

4. When configuring webhooks, you can specify:

   • A callback URL where ConnectWise will send events
   • An optional signature key for added security
   • Whether events are enabled for the instance

5. The search results don't provide a comprehensive list of specific event types you can subscribe to via webhooks. However, they mention that webhooks allow access to ConnectWise event streams.

6. Webhooks enable real-time notifications of events without requiring constant polling of the API.

7. Third-party integration platforms like Zapier offer pre-built integrations between ConnectWise Manage and webhook services, suggesting webhook functionality is available.

8. ConnectWise has a marketplace with third-party integrations, which may include additional webhook-related capabilities.

In summary, while the official ConnectWise Manage API does support webhooks, the search results don't provide a detailed list of specific event types available for subscription. To get a comprehensive list of supported webhook events, you would likely need to consult the official ConnectWise API documentation or contact their support directly.

Rate Limits and other limitations

Here are the key points about API Rate Limits for the ConnectWise Manage API:

Page Size Limits

• The API automatically sets page size to 25 results by default.
• The maximum page size for any request is 1,000 records.
• These page size values (25 default, 1,000 max) cannot be changed.

Time-Based Logging Limits

• API logging must be specifically turned on.
• There is a time limit of 1440 minutes (24 hours) that can be recorded in a single logging session.

Authentication Requirements

• SSL is required on production PSA servers when accessing the API.
• Any calls received via regular HTTP will be denied on production systems.

Other Considerations

• The documentation does not mention any specific rate limits in terms of number of requests per second/minute/hour.

• There are no explicit mentions of throttling or request quotas.

• The terms of use state that ConnectWise reserves the right to modify or discontinue the API at any time, which could potentially include imposing rate limits in the future.

• Developers are required to comply with applicable laws and protect user data when using the API.

In summary, while there are some limits around page sizes and logging durations, the documentation does not specify hard API rate limits in terms of request frequency. However, developers should be aware that ConnectWise retains the right to modify API access and may impose additional limits in the future if needed. It's recommended to design integrations to be respectful of server resources and to handle potential rate limiting gracefully.

Latest API Version

Unfortunately I could not find specific information about the most recent version of the ConnectWise Manage API in the provided search results. The search results contain general information about ConnectWise's developer tools and integrations, but do not mention API version numbers.

To provide the most accurate answer, I would need to check ConnectWise's official developer documentation or release notes for the latest API version information. Without that, I cannot confidently state what the most recent version is.

Key points to consider:

• ConnectWise offers APIs and SDKs for integrating with their products like ConnectWise PSA (formerly Manage) and ConnectWise Automate.

• They have a developer portal at developer.connectwise.com where the latest API documentation would likely be available.

• ConnectWise encourages third-party integrations through their Marketplace and Invent program.

• API versions may be updated periodically as new features are added or changes are made.

To get the definitive answer on the latest API version, I would recommend:

1. Checking the official ConnectWise developer documentation
2. Contacting ConnectWise support directly
3. Looking for any recent announcements or release notes about API updates

Without access to that information, I cannot provide the specific version number you're looking for. I apologize I couldn't give a more complete answer based on the available search results.

How to get a ConnectWise Manage developer account and API Keys?

To get a developer account for ConnectWise Manage to create an API integration, you need to follow these steps:

1. Register for an account on the ConnectWise Developer Network:

   • Go to the ConnectWise Developer Network website (developer.connectwise.com)
   • Click on the "Register" button
   • Fill out the registration form with your company details
   • Use a company-branded email address
   • Clearly state the intentions of your integration

2. Go through the approval process:

   • ConnectWise manually approves all applications
   • They will review your registration details and integration plans
   • You may be assigned to one of three categories: Partner Integrators, Solutions Partners, or Invent Solutions Partners

3. Request a test environment (if needed):

   • Developer Accounts are only available for integration development on integrations that will be publicly available on the ConnectWise Marketplace or The Control Integration Library
   • Include as many details as possible when requesting an instance
   • Note that existing partners should contact their account manager for environment requests

4. Access the Developer Network resources:

   • Once approved, you'll have access to API documentation, developer guides, and FAQs
   • Review the developer guide thoroughly before starting your integration work

5. Develop your integration:

   • Use the provided Developer Content and Developer Tools to create your integration
   • Adhere to the terms and conditions outlined in the Developer Network agreement

6. Consider joining the ConnectWise Invent program (optional):

   • This program provides additional resources, support, and exposure for Solutions Partners
   • It offers access to integration best practice blueprints and certification eligibility

What can you do with the ConnectWise Manage API?

Based on the information provided in the search results, here is a summary of the data models you can interact with using the ConnectWise Manage API:

Companies

• Create and update company records
• Map companies to tenants/customers
• Sync company information between systems

Agreements

• Create and update agreement records
• Map agreements to companies/customers
• Sync agreement details between systems

Products

• Create and update product records
• Sync product catalog information
• Categories include:
  • Cloud services
  • Software
  • Hardware/Virtual
  • Network devices

Configurations

• Create and update configuration records for network devices and appliances
• Sync asset/inventory information

Tickets

• Create service tickets automatically from alerts
• Update and close tickets automatically

Additions (Billing Items)

• Create and update billing additions on agreements
• Sync monthly billing information

Members/Users

• Create API members/users
• Manage API keys and permissions

Key points:

• The API allows syncing data bidirectionally between ConnectWise Manage and integrated systems
• It supports automating processes like billing, asset management, and ticketing
• Custom API roles and permissions can be configured
• The integration requires proper setup of companies, agreements, and product catalog in ConnectWise Manage

The API provides comprehensive access to core PSA (Professional Services Automation) data models to enable integration with other business systems and automation of key processes.