Connectors

Returns a list with all the available connectors from Tray's connector library.

A connector can have multiple versions.

the following key data is returned:

• Connector name and version are required inputs for Get connector operations and Call connector
• The service id is required for building the url for the Auth-only dialog

Returns a list with all the available operations for a given connector

Each connector operation has an input and output schema that can be used by a frontend to build a form or validate data.

You can then use the schema to correctly construct your inputs for the 'Call connector' operation.

Executes an operation of a connector and returns the result as the response.

The input is a regular json object that must fit the input schema of the operation as retrieved from Get connector operations. The authId field should be the id of a previously created authentication.

The output is also a regular json object containing the response from the 3rd party. The outcome field indicates whether or not the execution was successful.

3rd party errors

It is important to understand that responses can come from either Tray or the 3rd party API.

• All non-200 responses (400 Invalid input, 401 Unauthorized etc.) will be responses from Tray

• A 200 response indicates that Tray completed a call to the 3rd party:

Therefore a 200 response does not necessarily indicate success and will contain any success or failure responses from the 3rd party.

For example the following call to Slack which attempts to send a message to a channel which does not exist:

{
    "operation": "send_message",
    "authId": "af75fxxx-xxx-xxx-xxx-xxx8c494c5",
    "input": {
        "channel": "test200",
        "text": "more please!",
        "as_user": true
    },
    "returnOutputSchema": false
}

Will return a status of 200, as the input met Tray's schema requirements, but within the 200 response we will see that Slack has returned an error:

{
    "outcome": "error",
    "output": {
        "response": {
            "statusCode": 200,
            "body": {
                "ok": false,
                "error": "channel_not_found"
            }
        },
        "message": "Invalid response."
    }
}

Note that the exact error resonse format will vary from service to service, so some manual testing will be required to establish what this format is.

3rd party pagination

Certain 3rd party operations such as Salesforce 'List records' or Marketo 'List leads' may return long lists of data which will need to be paginated.

This can be dealt with using parameters such as ‘batch_size’ ‘next_page_token’ etc.

The exact pagination parameters will depend on the service.

Next page tokens and batch sizes will have to be passed in the call connector input.

The token for the next batch and e.g. ‘has more’ information will be returned in the 200 response.