Get Trigger

id

string

required

ID is the unique identifier of the Trigger.

method

enum<string>

required

HTTPMethod defines the HTTP method which will be used when invoking the Action. This is typically one of the standard HTTP methods such as GET, POST, PUT, PATCH or DELETE, but may be any valid HTTP method.

Available options:

GET,

POST,

PUT,

PATCH,

DELETE,

HEAD,

OPTIONS,

CONNECT,

TRACE

name

string

required

Name is a unique identifier for the Trigger within the scope of the Connector. It is expected to both human and machine-readable, i.e. "GetProduct" or "get_products", see the validation regex for more details.

parameters

object[]

required

parameters.in

enum<string>

required

Available options:

cookie,

header,

query

parameters.name

string

required

Name is the name of the parameter which will be sent to the HTTP endpoint.

parameters.required

boolean

required

Required denotes whether this parameter is required.

parameters.type

enum<string>

required

Type is the type of the parameter. Currently only scalar types are supported, if you require complex types then get in touch with support to discuss options.

Available options:

string,

number,

integer,

boolean

parameters.default

any

Default is the default value to use for the parameter if no value is provided by the user. If this is not defined then the parameter will not be sent to the HTTP endpoint if no value is explicitly provided by the user.

If this value is a string, it may be templated using a Go-formatted template string, i.e. {{ .conn.foo }} where foo is an connection variable defined in the Connector's Connection.

responses

object[]

required

Responses defines the expected responses from the HTTP endpoint. This is used to determine whether the Trigger was successful or not.

responses.definitions

object[]

required

a Trigger may support one Definition per media-type, i.e. application/json or application/xml etc. Attempts to link multiple Definitions with the same media-type will result in an error.

responses.definitions.definition

object

required

Definition describes a single definition of a type which is used by the Connector. The schema language used is dependent on the media-type of the Definition, for example JSON Schema is used for media-types application/json.

responses.definitions.definition.accept

string[]

required

Accept indicates which content types, expressed as MIME types, that this definition can accept. This value is analogous to the Accept HTTP header, as defined in RFC 7231, section 5.3.2, except each type is defined in a separate array element, rather than as a comma-separated list.

This does not represent the content type of the schema body itself, but the data which conforms to this definition. For example, an API may respond in JSON or YAML, but the schema may be a YAML-formatted JSON Schema. In this case, the Definition's accept field could be ["application/json", "text/yaml"] and schema.contentType will be application/schema+yaml.

responses.definitions.definition.id

string

required

ID is the unique identifier of the Definition.

responses.definitions.definition.name

string

required

Name is a unique identifier for the Definition within the scope of the Connector. It is expected to both human and machine-readable, i.e. "Product" or "product_variant".

responses.definitions.definition.url

string

required

URL is the location of the actual Schema definition for this Definition entity.

The structure of this URL will be consistent across all media types for each connection, for example:

https://platform.versori.com/api/schemas/v1/o/{organisation_id}/{connector_id}/{connector_version}/{definition_slug}.{media_type_ext}

responses.definitions.definition.description

string

Description is a human-friendly description of the Definition. This is typically used to describe the purpose of the Definition and how it should be used.

responses.definitions.definition.referencedBy

object[]

ReferencedBy is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.

responses.definitions.id

string

required

ID is a unique identifier for the request body within the scope of the Trigger.

responses.id

string

required

responses.status

integer

Status is the HTTP status code which is expected from the HTTP endpoint. If this is not defined then this response is treated as the default response, i.e. if no other response matches then this response will be used. a Trigger may only have one default response and each response must have a unique status code.

type

enum<string>

required

Available options:

http

description

string

Description is a human-readable description of the Trigger. It can provide extra information to users about how the Trigger operates and anything the user may need to be aware of when using it.

errors

object[]

Errors is a list of ErrorField objects which defines the errors which may be returned by the Trigger. An empty array denotes that the Trigger has been validated and no errors were found. If this field is undefined then this means validation has not occurred.

errors.field

string

required

Field is the field which failed validation. This is typically a JSON Pointer, i.e. "/parameters/0/properties/id", however this is open for discussion (we should be consistent with the ErrorField type).

errors.message

string

required

Message is a human-readable description of the error. This is typically a human-readable string, i.e. "The parameter 'id' is invalid".

errors.severity

enum<string>

required

Severity is the severity of the error. This is used to determine how the error should be displayed to the user, i.e. a warning may be displayed in a modal dialog, whereas an error may be displayed inline.

Available options:

error,

warning

requestBody

object

TriggerHTTPRequestBody defines whether a request body is required for a particular HTTP Trigger, and if so which Definitions are considered valid. If this value is undefined then no request body will be sent.

requestBody.definitions

object[]

required

a Trigger may support one Definition per media-type, i.e. application/json or application/xml etc. Attempts to link multiple Definitions with the same media-type will result in an error.

requestBody.definitions.definition

object

required

Definition describes a single definition of a type which is used by the Connector. The schema language used is dependent on the media-type of the Definition, for example JSON Schema is used for media-types application/json.

requestBody.definitions.definition.accept

string[]

required

Accept indicates which content types, expressed as MIME types, that this definition can accept. This value is analogous to the Accept HTTP header, as defined in RFC 7231, section 5.3.2, except each type is defined in a separate array element, rather than as a comma-separated list.

This does not represent the content type of the schema body itself, but the data which conforms to this definition. For example, an API may respond in JSON or YAML, but the schema may be a YAML-formatted JSON Schema. In this case, the Definition's accept field could be ["application/json", "text/yaml"] and schema.contentType will be application/schema+yaml.

requestBody.definitions.definition.id

string

required

ID is the unique identifier of the Definition.

requestBody.definitions.definition.name

string

required

Name is a unique identifier for the Definition within the scope of the Connector. It is expected to both human and machine-readable, i.e. "Product" or "product_variant".

requestBody.definitions.definition.url

string

required

URL is the location of the actual Schema definition for this Definition entity.

The structure of this URL will be consistent across all media types for each connection, for example:

https://platform.versori.com/api/schemas/v1/o/{organisation_id}/{connector_id}/{connector_version}/{definition_slug}.{media_type_ext}

requestBody.definitions.definition.description

string

Description is a human-friendly description of the Definition. This is typically used to describe the purpose of the Definition and how it should be used.

requestBody.definitions.definition.referencedBy

object[]

ReferencedBy is a list of DefinitionReference objects which defines what other entities are referencing the this Definition.

requestBody.definitions.id

string

required

ID is a unique identifier for the request body within the scope of the Trigger.

requestBody.required

boolean

required

Required denotes whether a request body is required for this Trigger.

summary

string

Summary is a human-readable version of the id field, i.e. "Get Product" or "Get Products". This is used when displaying the Trigger to users, however if omitted the TriggerId can be used to display to users instead.

API Reference

Connect API

Embedded API

Organisations API

Proxy API

Authorizations

Path Parameters

Response