Glossary of terms
- On this page
- Glossary of terms
- Basics
- Workflows
- Projects
When using Tray Embedded you will come across some common terms:
BasicsCopied!
Workflows Copied!
These are the building blocks of your integrations. A Tray workflow is what you use to perform a sequence of actions.
ProjectsCopied!
These are a collection of related workflows, i.e. workflows working towards a common goal. Workflows must always be added to a Project.
Solutions Copied!
You can create a 'solution' based on the workflows contained within a project. The solution will include all of the project workflows. This solution can then be included in your application and will be available for your End Users to activate and configure for their own use.
Publishing a SolutionCopied!
When a solution is edited (e.g. new features are added) a new version of that solution is created. All instances of this solution will be updated with the new features the next time the Solution Instance is used/triggered.
Solution InstanceCopied!
When an End User activates a Solution for their own use, they create a Solution Instance
End usersCopied!
The users of your integrations.
Auth and config dataCopied!
Config DataCopied!
Workflows contain variables (e.g. Slack channel, Trello board ID) which might need to be set by the End User of your solution. In the workflow configuration screen (accessed via the settings wheel in the top left corner of the edit workflow screen), these can be set as Config Data which can be named something like "slack_channel" and "slack_message" before being added to a relevant field in the step editor as $.config.slack_channel and $.config.slack_message. Any Config Data set in this way can then be used to allow the user to set their own data in the Configuration Wizard. The config data is also shared across workflows in a project.
Authentication DataCopied!
The data which is required (url, username, access_key etc.) when End Users are activating Solution Instances and authenticating with the required services.
Auth SlotsCopied!
Slots that allow auth data to be specified for solution instances when using the Config wizard or the auth-only dialog.
Config slotsCopied!
Slots that allow config data to be specified for solution instances when using the Config wizard or the Custom form.
Tokens and IDsCopied!
Embedded IDCopied!
an identifier that is used with the config wizard and auth-only dialogue to allow you to customise the styling of the dialogue. You can set this in the embedded settings section on your profile.
User/Owner IDCopied!
This is the end user's identifier in Tray.io
External user IDCopied!
This is a unique identifier with which you can distinctly identify your end users. You can store the mapping of the External user ID to the Tray user ID in your system/database and use it to extract the Tray user id which can then be used in Embedded APIs.
Solution IDCopied!
It is a unique identifier of a solution
Solution Instance IDCopied!
It is a unique identifier of a solution instance
Master tokenCopied!
This is a Bearer token that authenticates your account to use the Embedded GraphQL API
User tokenCopied!
This is a Bearer token that allows you to perform operations on behalf of an end user in the Embedded GraphQL API
Config wizard tokenCopied!
This is a one-time authorization code that is generated to open the config wizard
End user pathwaysCopied!
Tray Config wizardCopied!
It's a UI element hosted by Tray.io that you can incorporate into your product as a Popup or an iframe. In your application, when an end-user clicks the button to use a solution, this wizard will pop up. Here, they can use to add their own authentications and configurations for the solution (e.g. authenticate their Slack and Trello accounts and specify the content of automated messages).
Tray Auth Only DialogCopied!
It's a UI element hosted by Tray.io that you can incorporate into your product as a Popup or an iframe. Upon clicking a button, this dialogue will allow the users to add the authentication for a service. This is useful for integrations that do not require the End users to carry out any personalisation beyond authenticating with services.
Updating/Upgrading InstancesCopied!
Updating instanceCopied!
Solution instances have to be updated (other than 'lazy updates' that are handled by Tray) when the End user changes the authentication or configuration details of a solution instance.
Upgrading instanceCopied!
Solution instances have to be upgraded to a newer version of a solution (published after the instance was created) when you add new authentications or configurations to the instance.