Skip to main content

Overview

MossDesk works in any CI/CD environment. Use the CLI for shell-based workflows or the API for HTTP-based integrations. Both support --json output and API key authentication.

API key management

Create a dedicated API key for CI/CD use:
Store the key as a secret in your CI platform:
  • GitHub Actions: Repository Settings > Secrets > MOSS_API_KEY
  • GitLab CI: Settings > CI/CD > Variables > MOSS_API_KEY

GitHub Actions examples

Log deployment as interaction

Check overdue follow-ups on PR

Weekly pipeline report

API-based integration

For environments where you can’t install the CLI, use the REST API directly:

Scripting patterns

Iterate over contacts

Export and transform

Conditional deal updates

Idempotency

For CI/CD workflows that might retry, use idempotency keys to prevent duplicate operations:
The same idempotency key will return the original response without creating a duplicate.