Voidr API - Getting Started
Authenticate and run automated tests via API. Integrate with your CI/CD pipeline in minutes.Table of Contents
Initial Setup
- Create an API Key - Set up service account credentials
- Authenticate via API - Get your bearer token
- Configure Notifications - Set up webhooks to receive results
Discovery and Preparation
- Discover Test Plans - Find modules, suites, and test cases
Test Execution
- Execute All Application Tests - Run all test plans in an application
- Execute Specific Test Plan - Run individual plans or targets
- Select Notifications - Control which webhooks receive results
Result Queries
- Fetch Execution Status - Get execution status and results
- Fetch Execution History - Query historical executions
Webhooks and Integration
- Webhook Payload - Understand the webhook structure
Quick Start
To get started with the Voidr API:- Create a Service Account - Generate your
clientIdandclientSecret - Get an Access Token - Authenticate to receive a bearer token
- Configure Webhooks - Set up endpoints to receive test results
- Discover Your Tests - Explore your test plan structure
- Execute Tests - Trigger test runs via API
- Monitor Results - Poll for status or receive webhook notifications
Throughout this guide, you’ll see variables like
API_URL (base URL including /v1) and ACCESS_TOKEN (bearer token from authentication). Replace these with your actual values.