boards
- GETGet organisations boards
- POSTPost organisations boards
- POSTPost organisations myfirstboard
- PUTPut organisations boards
- DELDelete organisations boards
- POSTPreview the output of a Code Action.
- POSTPost organisations boards actors test
- POSTPost organisations boards publish
- POSTPost organisations boards unpublish
- GETGet organisations boards out of date board nodes
- GETGet organisations boards variables
- PUTPut organisations boards variables
- PUTPut organisations boards variablesglobal
- PUTPut organisations boards variablesdynamic
- GETGet organisations out of date board nodes
- GETGet organisations boards actors codelogs
- GETGet organisations boards execution logs
- POSTPost organisations board instances incoming webhooks
- POSTPost organisations board instances trigger execution
hubs
- GETGet organisations hubs
- POSTPost organisations hubs
- PUTPut organisations hubs
- DELDelete organisations hubs
- GETGet organisations hubs boards
- POSTPost organisations hubs boards
- GETGet organisations hubs boards integration info
- GETGet organisations hubs users
- GETGet organisations hubs boards users
- POSTPost organisations hubs boards users
- DELDelete organisations hubs boards users
data-mappings
- GETGet organisations data mappings
- POSTPost organisations data mappings
- PUTPut organisations data mappings
- DELDelete organisations data mappings
- GETGet organisations data mappings entries
- POSTPost organisations data mappings entries
- PUTPut organisations data mappings entries
- DELDelete organisations data mappings entries
apps
operations
schemas
- GETGet organisations schemas
- POSTPost organisations schemas
- GETGet organisations schemas info
- DELDelete organisations schemas
- POSTPost organisations schemas clone
- POSTPost organisations schemas publish
- GETGet organisations schemas operations
- POSTPost organisations schemas operations
- PUTPut organisations schemas operations
- DELDelete organisations schemas operations
- GETGet organisations schemas components
- POSTPost organisations schemas components
- PUTPut organisations schemas components
- DELDelete organisations schemas components
- POSTPost organisations schemas delete components
- POSTPost organisations schemas operation builder
- PUTPut organisations schemas import
- POSTPost organisations schema utils import
connections
credentials
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/hubs/{hubId}/boards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"status": "unknown",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hubId": "<string>",
"activePublishInfo": {
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"security": {},
"additionalHeaders": {},
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"recentPublishHistory": [
{
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"security": {},
"additionalHeaders": {},
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"deletedAt": "2023-11-07T05:31:56Z",
"tags": {},
"thumbnailUrl": "<string>"
}Post organisations hubs boards
Creates a board associated with the given Hub ID.
curl --request POST \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/hubs/{hubId}/boards \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"status": "unknown",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"hubId": "<string>",
"activePublishInfo": {
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"security": {},
"additionalHeaders": {},
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"recentPublishHistory": [
{
"id": "<string>",
"taskId": "<string>",
"lastEventId": "<string>",
"listeners": [
{
"id": "<string>",
"appNodeId": "<string>",
"operationNodeId": "<string>",
"url": "<string>",
"contentType": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"security": {},
"additionalHeaders": {},
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"deletedAt": "2023-11-07T05:31:56Z",
"tags": {},
"thumbnailUrl": "<string>"
}Authorizations
Body
Payload to create a new Board belonging to a Hub.
Response
A single Board result
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.
unknown, draft, publishing, published, unpublishing BoardPublishInfo provides information on a published board instance
Show child attributes
Show child attributes
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.
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.
Show child attributes
Show child attributes
AppNodeID is the identifier of the App Node to which this listener's operation belongs to.
OperationNodeID is the identifier of the Operation within the App Node, which is listening for data from an external source.
URL is the address for where the Node specified by NodeID is listening. Downstream services (such as webhooks) should be configured with this URL.
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.
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.
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.
Show child attributes
Show child attributes
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.
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.
Show child attributes
Show child attributes
AppNodeID is the identifier of the App Node to which this listener's operation belongs to.
OperationNodeID is the identifier of the Operation within the App Node, which is listening for data from an external source.
URL is the address for where the Node specified by NodeID is listening. Downstream services (such as webhooks) should be configured with this URL.
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.
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.