Customizing Connectors

Adapt an existing connector — its actions, fields, and data mappings — by pulling it down with the StackOne CLI, editing the YAML, and pushing your changes back.

Install the CLI

npm install -g @stackone/cli

Authenticate

Set up a profile with your API key. Customizing needs an API key with the connectors:read and connectors:write scopes.

stackone init

Pull the connector

Download the connector’s files to your machine.

stackone pull --connector [provider] --profile [profile-label]

Files save to ./connectors/[provider]/ by default. Append a version to pull a specific one, such as --connector [provider]@1.0.0, or pass --output-path to save elsewhere.

Make your changes

Edit [provider].connector.s1.yaml to adjust authentication, add or change actions, and map provider fields to your own schema.

Connector YAML Reference

Every field, step function, and expression the schema supports.

Validate as you edit

Check syntax and structure. --watch re-runs on every save.

stackone validate ./connectors/[provider]/ --watch

Test an action

Run an action against a linked account to confirm your changes behave as expected.

stackone run \
  --connector [provider].connector.s1.yaml \
  --account-id [account-id] \
  --action-id [action-id]

Push your changes

Upload the updated connector back to StackOne.

stackone push ./connectors/[provider]/ --profile [profile]

CLI Reference

All commands, flags, and test-file formats.

First Connector Build Workflow