Custom Integration

Welcome to the ConnectBooster Online Documentation Center

This is where your IT company will learn about ConnectBooster's support and installation process.

Here, your MSP will get educated on things like the installation procedure, functionality and capability for your IT clients, the dashboard that your end-users will view and where to go to get help when needed.

There is a lot here. If you cannot find what you need, contact us by clicking here and filling out this form, so we may better serve you. (we'd put an email address on this page, but we are scared to death of being spammed)

Custom Integration Setup

Setting up a Custom Integration

The "Custom" integration type supports HTTP Web Request Commands.
This allows you to use data from your own system, for the supported commands.
For example, "GetInvoiceImage" is a command that allows you to use your own invoice PDF when clicking "VIEW" on a given invoice within the portal. To add a new Custom integration type , please contact ConnectBooster Support.

Back To Top

Using Web Request Commands

Each Custom integration command requires the configuration of a web request. When the command is used, a request is sent to a provided URL using the configured settings. For example, when using the GetInvoiceImage command the request is sent when an invoice is viewed.

Tokens

Tokens are variables that can be used to pass in dynamic data. Tokens are case-sensitive and must be used in the following format: {{TokenName}}. For example, {{InvoiceNumber}} will be replaced with the invoice number of a selected invoice (e.g. ‘INV0000001’).

Method

The request method, such as GET or POST.

URL

The URL of the request. URL data should be encoded. Use tokens to pass in dynamic values.

Body

Additional data to be sent with a POST request. If your server requires the appropriate Content-Type header to process the data, add a Content-Type header. Use tokens to pass in dynamic values.

Headers

Additional headers to be sent with the request. For example, if your request body contains URL-encoded form data, the following header should be used: If your request body contains JSON data, the following header should be used:

Back To Top

Commands

GetInvoiceImage Command

Use this command to provide a custom invoice image as a PDF document. The custom invoice image is displayed when an invoice is viewed. Configuration:  
  • Next, go to Settings > Configurations > Billing
    • Under Invoice Image Data, enable the Invoice Image from the Custom Integration
 
  • Save
    token: InvoiceNumber   Be sure to take note of the {{InvoiceNumber}} reference in the URL path in the above example. This is a variable that the system replaces with an actual invoice number a customer wishes to view during runtime. For this reason, your file names and locations must always be consistent for the integration to work. Note: the {{InvoiceNumber}} variable does not include its own “.pdf” file extension, so remember to add it if that's your invoice format.

Back To Top

LoginWithToken Command

Use this command to allow another application to authenticate a ConnectBooster user and login into the ConnectBooster portal without having to enter credentials. Configuration:
  1. Add a Custom Integration using the LoginWithToken Command.
  2.  Select Post or Get for the Method type.  Modify the URL to the address of the application authentication service.  Click Save.
authToken: A onetime use token that we'll post back to your server to validate the token ipAddress

Back To Top