Best Practices For Building Connectors
Practical tips for building connectors that are reliable, secure, and easy to maintain, plus a look at how Connect keeps your data and credentials safe
Building connectors well keeps your automations reliable, secure, and easy to maintain. This article gathers the practices that help most, along with how Connect protects your data and credentials.
Build incrementally and test as you go
Rather than building an entire automation and running it blind, add one node at a time and use Test Node to confirm each works before moving on. The green and red feedback shows you exactly where a problem is, and the View Data Flow icon lets you inspect the data entering and leaving a node so you can catch issues early.
Keep credentials in variables
Store API keys, secrets, and tokens as variables under Settings > Variables and reference them with ENV. rather than typing them directly into nodes. This keeps sensitive values out of individual automations, makes them easy to rotate, and lets you reuse them across automations.
Schedule and monitor
Schedule automations to keep your data current without running them more often than needed, and check the Execution Records under Activity to confirm runs are succeeding. The execution details also show the tokis each run consumes, which helps you keep usage efficient.
How Connect protects your data
Connect is built with several safeguards you can rely on when handling sensitive data:
- Automations run in quarantined execution environments, so data is processed in isolation.
- All user information is stored in an encrypted database on AWS.
- Strict user access controls mean only authorised individuals can modify and import data in Connect and CyberHQ.
- Incoming data is continuously monitored to detect unusual activity, and input protection mechanisms guard against data leakage.
- Each connector has its own endpoint and access token, so one connector's credentials cannot be used to act on another (for example, a Jira connector's authorisation cannot upload to a Crowdstrike connector).
API tokens expire every 30 days, which reduces the risk of unauthorised access. Plan to rotate your tokens accordingly.
Start from templates and the per-tool guides
Where a template exists for the tool you are connecting, start from it rather than building from scratch, then adjust it for your environment. For tool-specific setup, including the exact credentials, URLs, and node configuration, follow the relevant guide in the Connector Documentation section.