Gearset | Atomicwork | Documentation

Gearset: Overview and setup

Automate Salesforce deployments, CI/CD pipelines, and metadata backups.

Connect Gearset to Atomicwork to automate Salesforce deployments, manage CI/CD pipelines, and handle metadata backups as part of your DevOps workflows.

Use cases

By connecting Gearset, your teams can:

Automate Salesforce deployments: Trigger and manage Gearset deployments from Atomicwork workflows — for example, kicking off a deployment to a sandbox when a change request is approved.
Manage CI/CD pipelines: Trigger, monitor, and manage CI/CD pipelines for Salesforce environments.
Automate metadata backups: Schedule and manage metadata backups for Salesforce orgs through workflow automation.
Custom operations: Execute any Gearset API call for workflows beyond standard use cases.

Permissions

To connect Gearset to Atomicwork, you need:

Org admin access in Atomicwork
Admin access to your Gearset account with permission to generate API token

The integration authenticates using an API token generated in Gearset. The token must have the following permissions for the actions you plan to automate:

Permission	Purpose
Deployments: Read/Write	Read and write access to deployment metadata. Required for triggering and managing Salesforce deployments from Atomicwork workflows.
CI/CD pipelines: Manage	Permission to trigger, monitor, and manage CI/CD pipelines. Required for pipeline automation workflows across Salesforce environments.
Metadata backups: Manage	Permission to schedule and manage metadata backups. Required for backup automation and restore operations.

[!NOTE] Note: Gearset manages API token permissions within its own dashboard rather than via OAuth scopes. Generate the token with the minimum permissions you need for the workflows you plan to run.

Setup

In your Gearset account, generate an API token with the permissions listed above.
Go to Settings > Enterprise integrations > App store > Gearset in Atomicwork.
Enter your API token.
Click Connect to activate the integration.

Supported workflow actions

Action	Description
Call API	Make a generic API call to any Gearset endpoint. Use this for all deployment, pipeline, and backup operations.

[!NOTE] Note: Gearset currently supports the Call API action, which gives you access to the full Gearset REST API. Refer to the Gearset API documentation for available endpoints.

Troubleshoot common issues

Error	Cause	Resolution
Missing API token	The API token was not provided during setup.	Enter the API token in Settings > Enterprise integrations > App store > Gearset.
Authentication failure (401/403)	The API token is invalid, expired, or lacks required permissions.	Generate a new API token in Gearset with the necessary permissions and update it in Atomicwork.