ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

This node integrates with the ConnectWise Manage API to perform various operations on different resources within ConnectWise Manage. Specifically, for the Schedule resource with the Get operation, it retrieves detailed information about a specific schedule entry by its unique Schedule ID.

Common scenarios where this node is beneficial include:

  • Fetching details of scheduled tasks or appointments in ConnectWise Manage.
  • Automating workflows that require schedule data retrieval for reporting or processing.
  • Integrating schedule information into other systems or dashboards.

For example, you might use this node to get the details of a particular schedule entry to check its timing, assigned resources, or related metadata before triggering follow-up actions.

Properties

Name Meaning
Schedule ID The unique identifier of the schedule entry to retrieve. This is required to specify which schedule entry's details to fetch.

Output

The output of the node is a JSON object representing the schedule entry retrieved from ConnectWise Manage. The structure corresponds directly to the schedule entry fields as defined by the ConnectWise Manage API under the schedule/entries endpoint.

  • The json output contains all the properties of the schedule entry, such as IDs, timestamps, related objects, and any custom fields associated with the schedule.
  • There is no binary data output for this operation.

Example output (simplified):

{
  "scheduleId": 12345,
  "objectType": "ServiceTicket",
  "objectId": 67890,
  "startDate": "2024-06-01T09:00:00Z",
  "endDate": "2024-06-01T10:00:00Z",
  "memberId": 111,
  "locationId": 222,
  "notes": "Scheduled maintenance task"
}

Dependencies

  • Requires an active connection to the ConnectWise Manage API.
  • The node needs credentials configured with appropriate API authentication tokens or keys to access the ConnectWise Manage instance.
  • The base URL of the ConnectWise Manage site must be provided in the credentials configuration.
  • No additional external dependencies are required beyond the ConnectWise Manage API access.

Troubleshooting

  • Missing or invalid Schedule ID: The node requires a valid Schedule ID to fetch the schedule entry. Ensure the Schedule ID is correctly provided and exists in ConnectWise Manage.
  • Authentication errors: If the API credentials are incorrect or expired, the node will fail to authenticate. Verify the API key/token and permissions.
  • API endpoint errors: If the ConnectWise Manage API endpoint URL is misconfigured or the service is down, requests will fail. Check the site URL and network connectivity.
  • Unsupported operation or resource: The node explicitly checks for supported operations and resources. Using unsupported combinations will throw errors indicating the operation/resource is not supported.
  • Rate limiting or API limits: Frequent calls may hit API rate limits imposed by ConnectWise Manage. Implement retry logic or reduce call frequency if needed.

Common error messages:

  • "Operation 'get' is not supported for resource 'schedule'": Indicates a mismatch or typo in resource or operation names.
  • "API request failed": Generic failure; check API response body for more details.
  • "No schedule entry found with the given Schedule ID": The specified Schedule ID does not exist.

Links and References

Discussion