Skip to main content

App Schema

The app schema is the main schema of the app. It is used to define the structure of the app.

To explore the app schema, you can use our schema explorer.

Metadata

You can define the metadata of the app at the root of the schema.

{
"name": "My App",
"version": "1.0.0",
"description": "My App Description"
}

Automations

An automation is a collection of actions that are triggered by an event.

{
"automations": [
{
"name": "My Automation",
"trigger": {
"service": "http",
"event": "GET",
"path": "/my-automation"
},
"actions": [
{
"name": "My Action",
"service": "http",
"event": "response",
"body": {
"message": "Hello, world!"
}
}
]
}
]

Using Environment Variables

You can use environment variables anywhere in the app schema. It will be replaced with the value of the environment variable at runtime.

{
"name": "{{env.NAME}}"
}

You can also provide a default value if the environment variable is not found.

{
"name": "{{env.NAME \"default\"}}"
}