The Standard Experience (Config Wizard)
This page will introduce you to all the API calls necessary in order to register an End User and allow them to click on an available solution to activate their own instance.
Each API call will need the correct token (master or user) passed as a bearer. This is done largely automatically in our Insomnia collection (once you add your master token to the environment) but will need to be entered manually when using the GraphQL playground.
You will be able to simulate an End User clicking to configure a Solution Instance by deploying the Integration Marketplace App and completing the setup of a Solution Instance for that End User.
You will then be able to test the Solution Instance by pasting its webhook URL into your browser. As it is a webhook-triggered workflow, this will trigger a run of the End User's Workflow Instance.
Finally, you can then login to the Tray Embedded UI to find the End User's Solution and Workflow Instances, to see how debugging works.
The steps have been summarised in a tutorial:
Notes on the user journeyCopy
Note that, while there may be a fairly 'linear' process for when an End User first configures an integration for their use, the API calls by your app are not necessarily made in a strict order.
For example, an End User may need to edit their settings for an integration at any point after they have registered.
You may also wish to list available integrations before a user has registered.
For each section below we have included a user journey diagram such as the following for when an End User logs in and available integrations are displayed:
Notes on Config Wizard URL and regionCopy
When initiating the Config Wizard for your End Users, you will need to compose the Config Wizard URL as such
This URL will vary depending on your region.
If you are in the EU region, the URL would be:
If you are in the APAC region, the URL would be:
Notes on using the Integration Marketplace appCopy
Register a userCopy
Log existing user inCopy
List available integrationsCopy
User configures integrationCopy
Create solution instanceCopy
Enable the Solution InstanceCopy
You can now return to the Users section of the UI and see that the Solution Instance for that End User is there, but currently disabled (this is to allow you to make any checks or changes before an Instance is activated):
Please not the warning below when enabling instances through the API:
Run and testCopy
Trigger a run of the Workflow InstanceCopy
Now you can paste the triggerUrl into your browser address bar and hit 'enter' to trigger a run of the Workflow Instance.
Debugging the Solution InstanceCopy
Return to the Users page on the UI and click on your end user. You will now see that the Solution Instance is enabled and you can click on 'Debug Workflows' on the solution instance card as shown below:
This will open a modal of all the linked workflows of this solution instance. You can the debug the workflow that you want.
This will open a read-only version of the Workflow in a new tab:
As you can see the log data is relevant to this particular End User - reflecting the Slack Channel and message entered in the Config Wizard.
And the webhook-triggered message has been sent to the Slack channel chosen by the End User in the Config Wizard:
List an End User's Solution InstancesCopy
User edits integrationCopy
Follow these steps to present this experience for end users:
Note on updating Solution InstancesCopy
When you (not end user) publish a new version of a Solution, there are two types of updates that would happen to all Solution Instances linked to this Solution:
A 'lazy' update (no new config or auths are required)
A 'breaking changes' update (i.e. requires new auth and/or config data) whereby you will have to notify End Users to edit their integrations as above
For more details, please see our guide to Updating Solutions and Instances.
User deletes integrationCopy
Delete solution instanceCopy
Users may want to delete the instance they no longer wish to use and you can achieve it by following the steps below: