Automate your Salesforce releases with the Blue Canvas API
Add your own checks, connect review comments and react to deployment events with a REST API and webhooks.
What you can build
Custom quality gates
Put a check status on a deployment. Connect your own analysis tools to release checks.
Code review comments
Post automated review comments. Reply to discussions and resolve comments through the API.
Slack bots and notifications
Use webhooks to connect commits and deployment events to your own Slack bot or notifications.
Repository exports
Download an archive of repository files for backups or audits.
Endpoints overview
Send REST requests to your own Blue Canvas domain.
Deployments
- Get a deployment by number.
Deployment Comments
- List, post and reply to comments.
- Resolve, edit and delete comments.
Deployment Checks
- Upsert a check status: error, failure, pending or success.
- Delete a check.
Repository
- Download an archive of the repository files.
React to commits and deployment steps
Use webhooks to react when a branch is committed or a deployment moves through creation, review, validation, deployment and comments.
Read the API docs- branches/committed
- deployments/created
- deployments/reviewed
- deployments/validating
- deployments/validated
- deployments/deployed
- deployments/commented
Put a check on a deployment
The npm package @bluecanvas/sdk handles authentication, retries and pagination.
The example projects include a PMD quality gate for Apex static analysis, built with the SDK, REST API and webhooks.
Simplified example. See the docs for exact parameters.
See the SDK in the docsimport { Client } from "@bluecanvas/sdk";
const client = new Client({ clientId, clientSecret });
await client.deployments.putCheck({
deploymentNumber,
checkName: "pmd",
body: {
state: "failure",
description: "3 Apex issues found"
}
});Connect the API to your AI tools
Bring Blue Canvas into the AI chat your team already uses.
Build your own MCP server
Use the Blue Canvas API to build a custom MCP server for your team. Give Claude, ChatGPT or Cursor safe access to your deployments, checks and comments, with the same permissions as your API user.
Or use the Blue Canvas MCP server
Coming soonComing soon. Ask your AI what changed in Salesforce, compare orgs and start deployment requests in plain language. Your approval rules still decide what ships.
Connect with OAuth 2.0
Use OAuth 2.0 client credentials. The authorization code flow is also supported.
API access follows the user's permissions. Account Owners get full access.
Tip: use a dedicated service user for your integration.
More about security- 1Create a Client ID and Secret in Profile > API Clients.
- 2Exchange your client credentials for a token.
- 3Send the token as a Bearer token with your API requests.
