API Reference

Authorization

Versori User Documentation

Home

Integrate

Embedded

Retrieves the boards belonging to a given organisation.


RecentPublishHistory is an array of BoardPublishInfo containing up to the last 5 publishes for a board. If
full history is required, users should use the ListPublishHistory operation for a paginated view.


BoardListener provides information on where a board is listening for external events.


AdditionalHeaders describes any other headers which the downstream service must supply with the request.


AppNodeID is the identifier of the App Node to which this listener's operation belongs to.


ContentType is the "content-type" header for which data should be sent with. Initially only
"application/json" is supported but other content types may be added in the future.


OperationNodeID is the identifier of the Operation within the App Node, which is listening for data from an
external source.


Security defines any parameters which external services must supply in order for Switchboard to acknowledge
an incoming event. If this is defined but an external service does not supply matching information, the
event will be ignored.


URL is the address for where the Node specified by NodeID is listening. Downstream services (such as
webhooks) should be configured with this URL.


BoardPublishInfo provides information on a published board instance

LastEventID is the last observed event before this board was published. This may not be the last event on
the stream for this board, since the observer may not have replayed all events at the time of publish. As
such, the version of the board which will be executed is defined by this field, and not necessarily the
latest event on the stream.


TaskID is a unique identifier for the execution of a board. Each time a board is (re)published a new task ID
will be generated.


BoardStatus is used to indicate the status of a board. The "unknown" status is used in case of inconsistencies
in the database with the Board scheduler and the API cannot deduce the correct status without administrator
intervention.

If the status is "unknown", then clients should assume it's in a draft/published state based on
whether the board has an "activePublishInfo" field. If a board cannot be published due to it already
being published and the "activePublishInfo" field is null, users should contact support.


apiKey

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

Provide credentials for a Connector to facilitate Versori to interact with an external system.

Connections

Build integrations between your systems with Boards.

How It Works

Creating a Hub

Quickstart React

Quickstart

React SDK

Build integrations between your internal systems.

Boards are the entrypoint to building integrations.

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.

Organisations API provides access to manage your Versori Organisation.

CreateSigningKey creates a new Signing Key for the Organisation. 

This API creates a new RSA key pair, storing the public key and returning the private key. The private key must 
be kept secure and should not be shared publicly as it has the ability to sign JWTs which can be used to 
authenticate to Versori APIs on behalf of your Organisation (or scoped to a specific End User within 
Versori Embedded).

If the private key is lost, it cannot be recovered and a new key pair must be generated. In this scenario, it is
the Organisation's responsibility to delete the Signing Key from Versori so that any JWTs signed by the lost key
are invalidated.


Create Signing Key

ListSigningKeys returns a list of all Signing Keys for the Organisation.


List Signing Keys

DeleteSigningKey deletes the signing key for the Organisation.

Any existing JWTs signed by this key will be invalidated and will no longer be accepted by the Versori platform.


Delete Signing Key

GetPublicKey returns the public key for the given Signing Key ID. This can be used to verify JWTs signed by an 
Organisation's Signing Key.


Retrieve public key

Proxy API enables authenticated requests through Connections in the Platform.

Use Cases

Endpoint

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

Boards

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


API Reference

Get organisations boards

Authorizations

Path Parameters

Query Parameters

Response