API Reference

Authorization

Versori User Documentation

Home

ListProtocols returns all the supported Protocols for this organisation. If a desired Protocol is not listed
then please contact support@versori.io to request it be added.


List Protocols

ErrorField denotes a field which has an error.

Field is the name of the field which has an error, this may be a path to a nested field, including array
elements. The format of this field is of the form: "field1.field2[0].field3"


Message is the error message for this specific field.

Protocol describes a protocol which is supported by Versori and can be used to communicate with an external
system.


Description describes the protocol in human-friendly terminology. This text may be displayed to users via a
help tooltip or similar.


IconURL provides a URL to access an icon/image which represents the protocol.

ID is the unique identifier of the Protocol, this is typically only used internally and the protocol `slug`
is used externally.


Name is a human-friendly name to display for the user.

Slug is human-readable unique identifier of the Protocol in kebab-case format.

ListProtocols returns all the supported Protocols for this organisation. 

If a desired Protocol is not listed then please contact support@versori.com to request it be added.


bearerToken

cookie

Welcome to the Versori Platform documentation.

Welcome

Introduction

Connect your APIs to the Versori Platform.

Overview

Learn about the protocols used by the Versori Platform.

Protocols

Authentication Methods

Actions

Triggers

Boards

Embed a native integration hub into your own application for your users.

Build integrations between your internal systems.

Select one of the following APIs to get started

Learn how to authenticate with the Versori Platform.

Authentication

Our next-generation API for connecting to your external systems.

Our next-generation API for exposing Versori-powered integrations to your users.

Welcome to the user documentation for the Versori Platform

Core Concepts

Within Switchboard, apps are the external-system nodes that you use to build out your integrations.

Apps

The Board Editor is your main tool for creating and editing boards. It is a visual tool that allows you to create and edit boards by dragging and dropping components onto the board.

Board Editor

The Hubs SDK is a tool that allows the users of your Product to integrate into different Apps you have configured in the Versori Platform.

Hubs SDK

Learn how to use Actions to automate your workflows.

The transformer action is a drag and drop action that allows you to transform the data in your workflow.

Transformer

The Databuilder allows for familiar form based templating and transformations

Databuilder

The filter action allows you to filter the resulting data based on a series of conditions.

Filter

Datamapper provides storage within Switchboard for remembering cross-system references to different entities.

Datamapper

The Batch action allows you to aggregate requests into a single output format.

Batch

The Delay Action is used to delay the execution of the next node in the workflow.

Delay

The Splitter Action accepts a List input and splits each item to be processed individually.

Splitter

The Trigger Action is used as a startpoint within your flows, to trigger requests either manually or on a schedule.

Trigger

Boards are built from Apps, and Actions in a drag-and-drop interface.

How to create a Board, an use the Board Editor

Multiple methods of connecting your apps are available.

How to Connect to your Apps

When building your integrations - you can add your operations from different systems, and provide further configuration.

How to add a Webhook Listener into your Integration

Selectors provide an intuitive interface for plucking data from previous steps in your flow, to be used within your requests and actions.

How to use Selectors to template data within your Integrations

The Hubs SDK enables users to authenticate and onboard into external integrations that are connected to your product

How to use the Versori Hubs SDK

Preview the output of a transformer. This endpoint is useful for testing a transformer before creating an integration.


Preview the output of a transformer.

Retrieve a signed URL for uploading a schema specification


Upload a schema document based on a source URL. The server will download this URL and upload to object
storage automatically.


SchemaInfo processes the schema referenced by the provided URL and returns information to allow a user to create
an App.

Deprecated: This endpoint is no longer supported, users should create a Schema using the `CreateSchema`
(POST /organisations/{organisationId}/schemas) operation, and use the `GetSchemaInfo` operation to retrieve
this information.


Retrieve a signed URL for uploading assets


List Protocols

Authorizations

Path Parameters

Query Parameters

Response