Our next-generation API for connecting to your external systems.
application/json
, defined by JSON Schemas.text/xml
, defined by XML Schema Definitions (XSDs).text/csv
, how this is defined isn’t known yet, however there are discussions in JIRA about this.publishedAt
field is not null.
Versions are defined as an arbitrary string, but users are encouraged to follow a consistent versioning scheme such as
SemVer, CalVer, or an incrementing number.
Connectors may only be used by Versori products if they are published, and once published they are immutable. If an edit
is attempted against a published version then an error will be returned. Unpublished Connectors are considered to be in
“draft” and can be edited as many times as required.
Connectors may be unpublished, but only when they are not referenced by any other system (see
Subscribers below).
publishedAt
field, whereas “default” will return the version which has been
set as such by the user. If the user never specifies a default version, the “latest” published version will be used.
channel
field in a Slack postMessage
call must be a valid channel name for the Slack Workspace in which the Connector is connecting to.
There are different mechanisms for defining Completions which are described below.
enum
keyword. Other media-types will have their own mechanisms which
may or may not be directly supported by their schema implementation.