The Display step allows you to “output” values from your spell. How it works exactly depends on how you run your spell:

  • For manual spells run through the Respell UI, the values will be shown in the UI after the spell finishes.
  • For manual spells run through the API, the values will be returned in the API response.
  • For trigger spells, the values will be shown in the History UI after the spell finishes.

The Display step is typically used for showing outputs in manual spells, or for debugging purposes in trigger spells. We recommend most spells have at least one Display step for monitoring your spell’s final output.

You can define as many outputs in a Display step as you’d like. To add a new one, click the “Add output” button. You can define the type (determines how it is displayed), label (ie. name), description (ie. subtext), and the value. Typically, the value is a variable from previous steps.

You can always click on the output to edit its details, or delete the output if you no longer need it.

​
Outputs

The Display step doesn’t have any outputs, however you can still add more steps after it.

​
Tips

  • If you’re running a manual spell, use the Display step to show output values to the users running the spell.
  • If you’re running a trigger spell, use the Display step to show important information that helps with understanding what happened during the spell run. This can come in handy when you’re debugging something wrong with your spell.
  • Use the Display step while building your spell to see outputs more clearly in the Test flow.
ConditionHuman Review