automationKinds

Required scopes: automations_read

Arguments

String

A trigger kind: each step’s availability says whether an automation on it can use the step.

[String!]

Kinds such as core.wait or core.wait@1, at most 100.

Returns

[AutomationKindInfo]!

required

A trigger or step kind: how editors present it, its default config, and the JSON Schema its config follows.

Show fields

AutomationStepAvailability

With forTrigger, whether an automation on that trigger can use the step; null otherwise and for triggers.

Show fields

Boolean!

required

Whether it can.

String

Why not, when it can’t.

AutomationStepCategory

A step’s category; null for a trigger.

JSON!

required

The JSON Schema of the config for this kind and version. It never changes once published: a change that breaks it publishes a new version.

JSON!

required

The config a new trigger or step starts from.

String!

required

What it does.

String

The area it belongs to, such as core or api.

String!

required

The domain’s display name.

[AutomationEffectClass!]!

required

What it does outside the run.

String

The event a trigger listens for; null for steps.

JSON

A trigger’s example event, the shape trigger has in expressions; null for steps.

String!

required

The folder editors list it under.

String

Why editors don’t offer the step for new automations; it stays valid in existing ones. Null when offered.

String!

required

An icon name.

String!

required

The kind, such as core.wait.

[AutomationPort!]!

required

The ports a step’s default config has; ports can depend on its config. Empty for a trigger, which always leaves by next.

Show fields

String!

required

The port’s id, as AutomationEdge.port names it.

String!

required

What editors show.

Boolean!

required

Whether a step can be disabled (AutomationStep.disabled); false for a trigger.

String!

required

Its display name.

AutomationKindType!

required

Trigger or step.

String

Why a trigger can’t start new automations; null when it can, and for steps.

String

Why diagnostics can’t see inside the step, such as code or a raw HTTP call; null for checked kinds.

Int!

required

The kind’s current version. New and saved automations use it; older configs are migrated up on save.

Example

query {
  automationKinds(forTrigger: "...", ids: "...") {
    category
    configJsonSchema
    defaultConfig
    description
    domain
    domainTitle
    effects
    event
    # ...
  }
}

Getting Started

Guides

Reference

automationKinds

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example