ConnectWise

​

Extra information

System documentation: ConnectWise API Reference

​

Connector package documentation

​

Table of Contents

• 1. Setting up HTTP Client ConnectWise
  • 1.1 Steps
• 2. Subscribing to entities from ConnectWise
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to ConnectWise
  • 3.1 Steps
  • 3.2 General concept

​

1. Setting up HTTP Client ConnectWise

1.1 Steps

1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client.
2. Select ConnectWise HTTP Client as PlatForm and click next step
3. Fill in the Base URI, Client ID, Company ID, Public Key and Private Key. (See the ConnectWise Authentication Documentation for more information)
4. You can optionally enable logging of request to get the log of the authentication.
5. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

​

2. Subscribing to Entities from ConnectWise

2.1 Steps

1. Go to Connections -> Incoming and create a new incoming configuration and select “ConnectWise Subscriber” as the subscriber.
2. Select the entity you want to subscribe to from ConnectWise.
3. Add any request parameters needed to subscribe to the entity.
4. Select the ConnectWise HTTP Client to use.
5. You can optionally add a transformer to transform the request parameters into something you will request from ConnectWise.
6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept We follow ConnectWise documentation on building this connector, so you can easily use the connector based on ConnectWise API Reference. Entity The entity you want to subscribe to ConnectWise. Please refer to the entities from ConnectWise API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on the ConnectWise API Reference. Please look at the example below on how to fill request parameters when we want retrieve an address format “AddressFormats - Get AddressFormat by id” entity. From the end point, we can see that we need to set the “id” as a path. That is why we set the “id” as a path the Request Parameters. Alumio will then make a request to ConnectWise with the URL /company/addressFormats/4

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0

HTTP Client The HTTP Client configuration you will use to access ConnectWise. 3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration and select “ConnectWise Publisher” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the ConnectWise entity you want the data to be published to.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. Select the HTTP Client to use.

3.2 General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. Method Currently, we support HTTP Post method, HTTP Put, HTTP Patch method and HTTP Delete method on submitting data to ConnectWise. Entity We support publishing to all ConnectWise endpoints. Please refer to ConnectWise API Reference page. For example, we want to update an address format. Please select “Put” as the Method and “AddressFormats - Put AddressFormat”. From the documentation, we can see that we need to set a path for “id” and a body parameters. That is why we set the “id” inside the path key and the body parameters inside the payload key in the data. Alumio will send an API request to ConnectWise with URL /company/addressFormats/4

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client The HTTP Client configuration you will use to access ConnectWise.