ConnectWise PSA

Cyware Orchestrate

ConnectWise PSA

App Vendor: ConnectWise

App Category: Case/Ticket Management

Connector Version: 1.0.0

API Version: v3.0

About App

ConnectWise PSA, previously known as Manage, furnishes the framework and features necessary for efficiently managing your IT department. It allows you to unify your team within a single system, facilitating seamless communication and collaboration through a centralized interface.

The ConnectWise PSA app is configured with Orchestrate to perform the following actions:

Action Name	Description
Create Catalog Item	This action creates a catalog item.
Create Task	This action creates a task for a ticket.
Create Ticket	This action creates a ticket.
Delete Catalog Item	This action deletes a catalog item.
Delete Task	This action deletes a task of a ticket.
Delete Ticket	This action deletes a ticket.
Get Catalog Item Details	This action retrieves the details of a catalog item.
Get Report Details	This action retrieves the details of a report.
Get Task Count	This action retrieves the count of tasks associated with a ticket.
Get Task Details	This action retrieves the details of a task associated with a ticket.
Get Ticket Details	This action retrieves the details of a ticket.
List All Catalog Items	This action retrieves the list of catalog items.
List All Reports	This action retrieves the list of reports.
List All Tasks	This action retrieves the list of tasks associated with a ticket.
List All Tickets	This action retrieves the list of tickets.
Post Ticket List	This action will post the list of tickets based on the conditions provided.
Update Catalog Item	This action updates a catalog item.
Update Task	This action updates a task of a ticket.
Update Ticket	This action updates a ticket.
Generic Action	This is a generic action used to make requests to any Connectwise PSA endpoint.

Configuration Parameters

The following configuration parameters are required for the ConnectWise PSA app to communicate with the ConnectWise PSA enterprise application. The parameters can be configured by creating instances in the app.

Parameter	Description	Field Type	Required/Optional	Comments
Client ID	Enter the client ID of the ConnectWise PSA account.	Text	Required
Username	Enter the username of the ConnectWise PSA account.	Text	Required
Password	Enter the password of the ConnectWise PSA account.	Password	Required
Company ID	Enter the company ID of the ConnectWise PSA account.	Text	Required
Base URL	Enter the base URL of the ConnectWise PSA account. Example: https://client.connectwise.org/v4_6_release/apis/3.0	Text	Required	Note To establish a successful connection, ensure that you append /v4_6_release/apis/3.0 to the base URL.
Timeout	Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with ConnectWise PSA.	Integer	Optional	Allowed Range: 15-120 Default value: 15
Verify	Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection.	Boolean	Optional	By default, verification is disabled.

Action: Create Catalog Item

This action creates a catalog item.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Catalog Item Data	Enter the catalog item data.	Key Value	Required

Example Request

[
  {
    "catalog_item_data": {
      "type": {
        "name": "Hardware"
      },
      "category": {
        "name": "Hardware"
      },
      "identifier": "test action catalog",
      "description": "for test purpose",
      "subcategory": {
        "name": "Miscellaneous"
      },
      "customerDescription": "testing purpose"
    }
  }
]

Action: Create Task

This action creates a task for a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Parent ID	Enter the parent ID of the ticket.	Text	Required	You can retrieve this using the action List All Tickets.
Task Data	Enter the task data.	Key Value	Required

Example Request

[
  {
    "parent_id": 560,
    "task_data": {
      "id": "26",
      "notes": "Creating a task"
    }
  }
]

Action: Create Ticket

This action creates a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Ticket Data	Enter the ticket data to create a ticket.	Key Value	Required

Example Request

[
  {
    "ticket_data": {
      "id": "1",
      "company": {
        "identifier": "SampleCompany"
      },
      "summary": "test"
    }
  }
]

Action: Delete Catalog Item

This action deletes a catalog item.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Catalog Item ID	Enter the catalog item ID.	Text	Required	You can retrieve this using the action List All Catalog Items.

Example Request

[
  {
    "catalog_item_id": 759
  }
]

Action: Delete Task

This action deletes a task of a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Parent ID	Enter the parent ID of the ticket.	Text	Required	You can retrieve this using the action List All Tickets.
Task ID	Enter the task ID.	Text	Required	You can retrieve this using the action List All Tasks.

Example Request

[
  {
    "task_id": 99,
    "parent_id": 560
  }
]

Action: Delete Ticket

This action deletes a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Ticket ID	Enter the ticket ID to delete the ticket.	Text	Required	You can retrieve this using the action List All Tickets.

Example Request

[
  {
    "ticket_id": 560
  }
]

Action: Get Catalog Item Details

This action retrieves the details of a catalog item.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Catalog Item ID	Enter the catalog item ID.	Text	Required	You can retrieve this using the action List All Catalog Items.
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "catalog_item_id": 743
  }
]

Action: Get Report Details

This action retrieves the details of a report.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Report Name	Enter the report name to get the details.	Text	Required	You can retrieve this using the action List All Reports.
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "report_name": "IVUom"
  }
]

Action: Get Task Count

This action retrieves the count of tasks associated with a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Parent ID	Enter the parent ID of the ticket.	Text	Required	You can retrieve this using the action List All Tickets.
Conditions	Enter the conditions to filter the tickets. Example: status='new'	Text	Optional
Page size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order by to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "parent_id": 560
  }
]

Action: Get Task Details

This action retrieves the details of a task associated with a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Parent ID	Enter the parent ID of the ticket.	Text	Required	You can retrieve this using the action List All Tickets.
Task ID	Enter the task ID.	Text	Required	You can retrieve this using the action List All Tasks.
Conditions	Enter the conditions to filter the tickets. Example: status='new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "task_id": 99,
    "parent_id": 560
  }
]

Action: List All Catalog Items

This action retrieves the list of catalog items.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "status": "new",
    "fields": "id,summary"
  }
]

Action: List All Change Orders

This action retrieves the list of change orders.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Action: List All Reports

This action retrieves the list of reports.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "status": "new",
    "fields": "id,summary"
  }
]

Action: List All Tasks

This action retrieves the list of tasks associated with a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Parent ID	Enter the parent ID of the ticket.	Text	Required	You can retrieve this using the action List All Tickets.
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "parent_id": 560
  }
]

Action: List All Tickets

This action retrieves the list of tickets.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Conditions	Enter the conditions to filter the tickets. Example: status = 'new'	Text	Optional
Page Size	Enter the page size to limit the number of tickets.	Integer	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Additional Data	Enter the extra parameters if any. Example: {"fields": "id,summary"}	Key Value	Optional

Example Request

[
  {
    "parent_id": 560,
    "extra_params": {}
  }
]

Action: Post Ticket List

This action will post the list of tickets based on the conditions provided.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Condition	Enter the conditions to filter the tickets. Example: status='new'	Text	Optional
Order By	Enter the order to sort the tickets. Example: id desc	Text	Optional
Child Conditions	Enter the child conditions to filter the tickets.	Text	Optional
Custom Field Conditions	Enter the custom field conditions to filter the tickets.	Text	Optional

Example Request

[
 {
  "status"= "new"
 }
]

Action: Update Catalog Item

This action updates a catalog item.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Catalog Item Data	Enter the catalog item data.	Key Value	Required
Catalog Item ID	Enter the catalog item ID.	Text	Required	You can retrieve this using the action List All Catalog Items.

Example Request

[
  {
    "catalog_item_id": "12",
    "catalog_item_data": {
      "op": "add",
      "value": {
        "taxableFlag": false
      }
    }
  }
]

Action: Update Task

This action updates a task of a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Parent ID	Enter the parent ID of the ticket.	Text	Required	You can retrieve this using the action List All Tickets.
Task Data	Enter the task data.	Key Value	Required
Task ID	Enter the task ID.	Text	Required	You can retrieve this using the action List All Tasks.

Example Request

[
  {
    "task_id": 99,
    "parent_id": 560,
    "task_data": {
      "notes": "Updated Task"
    }
  }
]

Action: Update Ticket

This action updates a ticket.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Ticket Data	Enter the ticket data to update the ticket.	Key Value	Required
Ticket ID	Enter the ticket ID to update the ticket.	Text	Required	You can retrieve this using the action List All Tickets.

Example Request

[
  {
    "ticket_id": 560,
    "ticket_data": {
      "team": {
        "id": 25
      },
      "board": {
        "id": 1
      },
      "impact": "medium",
      "status": {
        "id": 16
      },
      "company": {
        "id": 24,
        "identifier": "WildEagleInc"
      },
      "summary": "update test",
      "priority": {
        "id": 3
      },
      "severity": "medium"
    }
  }
]

Action: Generic Action

This is a generic action used to transcend the actions implemented by making a request to any endpoint

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Method	Enter the HTTP method to make the request.	Text	Required	Allowed values: GET POST PUT DELETE
Endpoint	Enter the endpoint to make the request. Example: /services/ticket/{ticket_id}	Text	Required
Query Params	Enter the query parameters to pass to the API.	Key Value	Optional
Payload	Enter the payload to pass to the API.	Any	Optional
Extra Fields	Enter the extra fields to pass to the API.	Key Value	Optional

Example Request

[
  {
    "method": "GET",
    "endpoint": "service/tickets",
    "extra_fields": {},
    "query_params": {}
  }
]

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.

Cyware Orchestrate

ConnectWise PSA

About App

Configuration Parameters

Note

Action: Create Catalog Item

Action: Create Task

Action: Create Ticket

Action: Delete Catalog Item

Action: Delete Task

Action: Delete Ticket

Action: Get Catalog Item Details

Action: Get Report Details

Action: Get Task Count

Action: Get Task Details

Action: List All Catalog Items

Action: List All Change Orders

Action: List All Reports

Action: List All Tasks

Action: List All Tickets

Action: Post Ticket List

Action: Update Catalog Item

Action: Update Task

Action: Update Ticket

Action: Generic Action

Search results