Overview
This node integrates with ConnectWise to retrieve notes associated with service tickets. Specifically, the Service Ticket Note - Get operation fetches all notes linked to a particular service ticket, optionally filtered and paginated.
Typical use cases include:
- Extracting detailed communication or updates recorded on a service ticket for reporting or auditing.
- Synchronizing service ticket notes into another system or database.
- Monitoring ticket progress by reviewing notes added by support agents.
For example, a user might want to get all notes for a specific service ticket ID, filtering only those that meet certain conditions (e.g., notes created after a certain date), and limit the fields returned to reduce payload size.
Properties
| Name | Meaning |
|---|---|
| Service Ticket ID | The unique numeric identifier of the service ticket whose notes you want to retrieve. Required. |
| Conditions | Optional string to filter the notes based on specified criteria (e.g., status, date). |
| Fields | Optional comma-separated list of fields to return for each note, limiting the data retrieved. |
| Page ID | Optional number specifying which page of results to retrieve when paginating through notes. |
| Page Size | Optional number defining how many notes to return per page; defaults to 1000 if not set. |
Output
The node outputs JSON data representing an array of service ticket notes matching the query parameters. Each note object typically includes details such as:
- Note text/content
- Flags indicating if it is internal analysis, detailed description, or resolution
- Metadata like creation date, author, and note ID
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the ConnectWise REST API.
- The base URL for API requests is dynamically constructed using the configured data center domain.
- The node sends HTTP GET requests to endpoints like
/service/tickets/{serviceTicketId}/notes.
Troubleshooting
- Missing or invalid Service Ticket ID: The operation requires a valid numeric service ticket ID. Ensure this is provided and correct.
- API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Empty results: If no notes are returned, check the
conditionsfilter for correctness or try removing it to broaden the query. - Pagination issues: When retrieving large numbers of notes, ensure
pageIdandpageSizeare set appropriately to navigate through pages. - Field filtering errors: Incorrect field names in the
fieldsproperty may cause incomplete or empty responses.