Compass Docs
Ask or search…
⌃K
Comment on page
📘

Key Terms in Automations

Learn what the jargon means
Compass Automations is an online automation tool that helps you build custom trading automations for NFTs without any coding experience. This guide will walk you through the key concepts to help you get started with Compass Automations.

Automation

An Automation is an automated workflow that connects various aspects of your trading activities. Each Automation consists of a trigger and one or more actions. When you enable your Automation, it will run the action steps every time the trigger event occurs.

Automation Builder

The Automation Builder is a user-friendly interface that allows you to create an Automation from scratch. In the Automation Builder, you can set up a trigger and one or more actions.

Automation Library (Explore)

The Automation Library, also known as Explore, is a collection of pre-made automations for various use cases. You can browse and choose from the best automations built by our team and start using them with just one click.

Trigger

A Trigger is an event that starts an Automation. For example, if you want to automatically buy a token when it is listed 50% below the floor price, the trigger is 'Token listed'. See the list of Triggers available here​

Action

An Action is an event an Automation performs after it is triggered. For example, if you want to automatically buy a token when it is listed 50% below the floor price, the action is 'Buy token'. See the list of Actions available here​

Variable

Data between your trigger and actions and automation inputs is passed on in variables. For example, the Get Collection Floor action passes on the collection floor as a variable. You can then use this variable in the List token action to list your NFT on the floor.

Inputs

Inputs are the data or values that go into a Trigger or Action in your Automation. They serve as the parameters or settings required for the specific Action to function correctly. Inputs can be user-defined or received from other parts of the Automation. For example The collection address you want to bid on can be an input for the Bid on Blur Action.

Outputs

Outputs are the results or data that come out of a trigger or action in your Automation. They are generated after the Trigger or Action has been executed and can be used as inputs for subsequent steps within the Automation, allowing you to create complex and interconnected workflows. For example, the collection floor from the "Get Collection Floor" action is an output that can be used as an input for a subsequent action, such as setting a bid price.

Automation Input

Automation Inputs allow you to add data in one place and pass that data as a variable to different actions and triggers within your Automation. They simplify the process of creating and reusing Automation templates. Automation Inputs are a certain type of Input that is specified in the beginning of an Automation or Template.
For example, if you want to repurpose an Auto Lister, you can use an Automation Input for the collection address. Instead of changing the collection address in multiple actions, you only need to update the Automation Input. Then, the updated input will automatically be used wherever the collection address appears in your Automation. This makes it easier to customize and repurpose your Automations.

Template

Templates allow you to repurpose and share Automations. By creating a template out of an Automation, you can easily reuse the structure of the Automation without duplicating it and manually changing all the inputs. Instead, you can create new Automations from the template with blank inputs that simply need to be filled out.
Templates are also a great way to share your Automations with others. If you have the right permissions, you can even submit your templates to the Automation Library, making them available for the wider Compass Automations community to use and benefit from.

Automation Run

An Automation Run refers to a single instance when an Automation is executed. It occurs when a trigger event is detected, and the Automation proceeds to carry out its actions. Each Automation Run represents a complete cycle of the trigger being activated and the corresponding actions being performed.
An Automation Run can have three results: Success - Successful automation run with all actions executed
Warning - Successful automation run with some action(s) hitting a non-breaking issue
Error - Failed automation run with an action hitting a breaking issue

Automation History

Automation History is a log of your Automation activity, including the details of each Automation Run, the data that flows in and out of each step, and any errors or issues that may have occurred during execution. By reviewing your Automation History, you can gain insights into the performance of your Automations, troubleshoot issues, and optimize your Automation logic.