Unify Logo Footer.svg
Platform Tools
Logo
Defining an automation interface

Defining an automation interface

Logo

3 mins READ

The interface editor — name, description, and the Setup/Result schemas that form the contract.

Overview

The editor's own description sums it up: "Leverage this to create an automation that is accessible from external sources. Define the output for trigger of this automation (Setup schema) and the result returned to the parent automation (result schema)." The form has:

  • Name — required.

  • Description — required. Write it for the people picking interfaces in a dropdown later.

  • Tags — pick or create labels.

  • Setup Schema — the input fields a caller supplies; these become the trigger's output inside implementing automations.

  • Result Schema — the fields an implementation returns to the caller.

Create / Save persists; Cancel goes back. Without edit permission an existing interface opens read-only.

Where: Automation Interfaces › New / Edit Automation Interface

inter-2.png
inter-2.png

Building the Setup and Result schemas

Each schema starts as No fields added ("Add your first field by giving it a name, type and default value") with two paths:

  • Add Fields — define fields one by one in the Add a field dialog.

  • Use Code Snippet — derive the fields from a sample payload or an existing snippet.

Repeat until the schema mirrors the data you expect in (Setup) and out (Result).

Where: Interface editor, Setup Schema / Result Schema

FAQs

What can a field be?

The Add a field dialog takes:

  • Key — starts with a letter; no spaces; no special characters except "_". Required.

  • Label — display name.

  • Field Type — String, Number, Integer, Boolean, Date, Date Time, Object, Array (with an Array Type of String/Number/Integer/Boolean/Object), or File.

  • Default value, Help Text, and Nest under (place inside an Object field).

  • Is Optional — on by default; turn it off to make the field mandatory for callers.

  • Setup-schema fields also offer Exclude field in runs — keep the field in the contract but leave it out of run payloads.

Where: Interface editor › Add a field

What happens to automations when I change a schema?

The schemas are live contracts: implementing automations read their trigger data from the Setup Schema, and callers map inputs against it and consume the Result Schema. Adding optional fields is safe; renaming or removing fields breaks mappings on both sides — update the implementing automations and every calling step after such a change.

Where: Interface editor, schema changes