Connectors / Service /

A SaaS recurring revenue & customer management platform. (updated: 1657717534106) is a SaaS recurring revenue & customer management platform.

Overview delivers a usage-based billing platform and a powerful customer management system to scale with your growing business.


When using the connector, the first thing you will need to do is go to your account page, and select the workflow you wish to work on. Once in the workflow builder itself, search and drag the connector from the connectors panel (on the left hand side) onto your workflow.

With the new connector step highlighted, in the properties panel on the right, click on the Authenticate tab followed by 'Add new authentication' (located under the 'Authentication' field).


This will result in a authentication pop-up window. The first page will ask you to name your authentication, and state which type of authentication you wish to create ('Organization' or 'Personal').

As you can see, the next page asks you for your 'Username', 'Password' and 'Client code' credentials.

These credentials will be provided on signup to the service.


Once you have added these fields to your authentication popup window, click on the 'Create authentication' button. Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Rev,io which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the API documentation v1.0, to find the exact format that will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for is:

For example, say that the 'List contacts' operation did not exist in our connector, and you wanted to use this endpoint, you would use the API docs to find the relevant endpoint - which in this case is a GET request called: /Contacts.

More details can be found here.


As you can see there is also the option to include query parameters, should you wish to do so. So if you know what your method, endpoint and details of your query parameters are, you can get a list of all contacts with the names 'David' and 'Julia' with the following settings:

Method: GET

Endpoint: /Contacts

Query Parameter: Key: Value: David,Julia

Body Type: none

Final example outcome being:


Example Usage

TRAY POTENTIAL: is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with and the connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the connector, to get information on a specific contact.

The steps will be as follows:

  1. Setup using a manual trigger and list all contacts

  2. Add the Loop collection connector to iterate over each individual contact.

  3. Gather the information available for each contact.

The final outcome should look like this:


1 - Setup Trigger & List contacts

Once you have clicked 'Create new workflow' from your main dashboard named it, select the Manual trigger from the trigger options available:


After you have been redirected to the workflow dashboard, from the connectors panel on the left, add a connector to your second step. Set the operation to 'List contacts'.


USER TIP: Feel free to re-name your steps as you go along, to make things clearer for yourself and other potential users of this workflow. Usually the operation name itself is enough however please note that there is also a 'Description' field available under the Describe tab.

List contacts has a number of fields that can be configured to customise results returned from the API which you are free to set according to your use case. The 'Page size' and 'Page' fields are set by default. In the example above we have additionally chosen to return the results in acsending order and to be ordered according to the Customer ID.

2 - Add a loop collection

Next, search for the Loop collection connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to loop over in the previous 'List contacts' connector step.

In order to specify the list you want to loop through, start by using the 'List' mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List contacts' step (with the tail end of the connector-snake), select records from the list of output properties displayed. This will auto-populate a jsonpath within your 'List' input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with, please see our Intro page and Data Guide for more details.

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.


This will enable us to iterate over the list of contacts, and perform operations on each one, during each loop cycle.

3 - Get contact

The last step is to drag a connector inside of the Loop Collection step itself. Set the operation to 'Get contact'. As you can see, the 'Contact ID' field is required. Use the same connector-snake method for generating the JSON path to get the 'Contact ID'.


Now when this workflow is run, you will be able to gather the information available for each contact. This means you will be able to view the contact's details when you click through your debug panel and expand the output.


BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:


Approve request

Approve an existing request.

Assign inventory item to customer

Assign a inventory item to a customer.

Assign inventory item to product

Assign multiple inventory items to a product.

Assign inventory item to service

Assign a single or multiple inventory items to a service.

Create contact

Create a new contact.

Create customer

Create a new customer account.

Create inventory item

Create a new inventory item.

Create inventory type

Create a new inventory type.

Create payment

Create a new payment.

Create service

Create a new service.

Create service product

Create a new service product.

Create task

Create a new task.

Create ticket

Create a new ticket.

Disconnect service

Disconnect an existing service.

Disconnect service product

Sets an existing service product to disconnected status.

Get bill

Find a bill by ID.

Get charge

Find a single charge by ID.

Get contact

Find a contact by ID.

Get customer

Find a customer account by ID.

Get inventory item

Retrieve a single inventory item.

Get inventory type

Retrieve a single inventory type.

Get payment

Find a payment by ID.

Get product

Find a single product by ID.

Get request PDF

Generate and download a PDF of a request. The request template you specify determines the format of the PDF. This can be used to create quotes.

Get service

Find a single service by ID.

Get service product

Find a single service product by ID.

Get task

Find a task by ID.

Get ticket

Find a ticket by ID.

Get ticket journal

Find a ticket journal by ID.

List bill profiles

Search for one or more bill profiles.

List bills

Search for one or more bills.

List charges

Search for one or more charges.

List contacts

Search for one or more contacts.

List contacts DDL

List customer fields DDL

List customers

Search for one or more customers.

List customers DDL

List customers metadata

Find metadata for one or more customers.

List inventory item identifiers DDL

List inventory items

Retrieve a list of inventory items and search through items.

List inventory items DDL

List inventory type fields DDL

List inventory types

Retrieve a list of inventory types.

List inventory types DDL

List payments

Search for one or more payments.

List products

Retrieves a list of products.

List products DDL

List request templates

Search for one or more request templates.

List request templates DDL

List service products

Search for one or more service products.

List service products DDL

List service types

List service types.

List service types DDL

List services

Search for one or more services.

List services DDL

List task fields DDL

List tasks

Search for one or more tasks.

List ticket fields DDL

List ticket journals

Search for one or more ticket journals.

List tickets

Search for one or more tickets.

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Reverse payment

Reverses an existing payment.

Run report

Run a report that doesn't require user input.

Run report with input

Run a report that requires user input.

Unassign inventory item from product

Unassign a single or multiple inventory items from a product.

Unassign inventory item from service

Unassign a single or multiple inventory items from a service.

Update contact

Update an existing contact.

Update customer

Update an existing customer.

Update inventory item

Update an existing inventory item.

Update inventory type

Replace an existing inventory type.

Update task

Update an existing task.

Update ticket

Update an existing ticket.