Integrate CXMind bot testing into your continuous integration pipelines
API Token
Use this token to authenticate API requests from your CI/CD pipeline
Store this token securely. It will only be shown once.
A CI/CD token is configured for this tenant.
Generate a new token to rotate it. The plaintext value is never shown again.
Generate an API token to authenticate CI/CD requests
API Endpoint
Use this base URL with the /api/cicd endpoints shown below.
Default Pipeline Bot
Choose the tenant bot used when a CI/CD request omits bot_id.
Generated examples can still pass bot_id explicitly; this default just gives the tenant a safe fallback.
Pipeline Integrations
GitHub Actions
Native GitHub CI/CD
Automate bot testing on every push or pull request with GitHub Actions.
GitLab CI
GitLab pipelines
Integrate with GitLab CI/CD pipelines for automated testing.
Jenkins
Open source automation
Add bot testing to your Jenkins pipelines with shell or Groovy scripts.
Azure DevOps
Microsoft pipelines
Integrate with Azure Pipelines for enterprise-grade CI/CD workflows.
CircleCI
Cloud-native CI/CD
Fast, cloud-native CI/CD with CircleCI orbs and workflows.
Bitbucket Pipelines
Atlassian CI/CD
Seamlessly integrate with Bitbucket Pipelines.
Travis CI
Open source CI/CD
Configure bot testing in your Travis CI pipeline.
AWS CodePipeline
AWS native CI/CD
Integrate with AWS CodeBuild and CodePipeline for cloud-native automation.
cURL / Shell Script
Generic integration
Use these curl commands in any CI/CD system or shell script.
Required Environment Variables
CXMIND_API_URL
- The CXMind API endpoint URL
CXMIND_API_TOKEN
- Your API authentication token (keep this secret!)
CXMIND_BOT_ID
- The ID of the bot to test (optional if a default bot is configured)
API Reference
/api/cicd/runs
Trigger a new test run with a tenant-scoped CI/CD token
{
"bot_id": "your-bot-id", // Optional when a default bot is configured
"name": "CI/CD Test Run",
"test_case_ids": [] // Empty = run all test cases
}/api/cicd/runs/{run_id}
Get the status and results of a test run
/api/cicd/runs/{run_id}/junit
Download JUnit XML report for CI/CD test result parsing
Webhooks
Receive HTTP callbacks when test events occur
No webhooks configured
Create a webhook to receive notifications on test events
| Name | URL | Events | Status | Actions |
|---|---|---|---|---|
|
|
|
Available Events
run.started
When a test run begins
run.completed
When a test run finishes
run.failed
When a test run has failures
test.passed
When a test case passes
test.failed
When a test case fails
regression.detected
When a regression is found