credentials

The shape of a credential, declared once per package. Never a value.

Generated from nodes/_schema/credential.schema.json, the same file the node linter validates against.

Example

credentials/<name>.yaml

name: airtableCredential
displayName: Airtable
description: Airtable Personal Access Token
documentationUrl: https://airtable.com/create/tokens

properties:
  - name: personalAccessToken
    displayName: Personal Access Token
    type: string
    required: true
    secret: true
    description: Your Airtable Personal Access Token
    placeholder: pat

Fields

string

required

The credential type’s id, referenced by interface.yaml.

string

required

The name on the form someone fills in. Write it for a person who has your service open in another tab.

string

One line saying what the credential is for, shown above the form.

string

A link to where the key comes from, shown beside the form.

object[]

required

The fields on the form. Mark anything that grants access secret: true.

Next steps

Building a node

The guides behind these fields.

Troubleshooting

When a node does not do what you wrote.

⌘I

Overview

Design

Nodes

Nodes · api/

Nodes · package

Example

Fields

Next steps

Building a node

Troubleshooting

​Example

​Fields

​Next steps

Building a node

Troubleshooting

Example

Fields

Next steps