Skip to main content

BetaTesting API & Webhooks Overview

How to use BetaTesting's API and Webhooks

Updated this week

The BetaTesting API allows you to programmatically manage your tests, testers, issues, activities, and community directly from your own applications and workflows. Webhooks let BetaTesting notify your systems in real time when important events occur: like a tester completing a test, a new issue being submitted, or a shipment status change.

Note: The API and webhooks are available exclusively on Enterprise plans. Contact your account manager or our sales team to enable API access for your organization.

What You Can Do

With the API, you can:

  • Create and manage tests programmatically

  • Accept, message, and manage testers

  • Retrieve and update issues (bug reports)

  • Create and manage activities (surveys/tasks)

  • Manage your tester community, custom fields, and tags

  • Retrieve messages, invites, and shipment data

With Webhooks, you can:

  • Receive real-time notifications when events happen on your tests

  • Trigger workflows in your own systems (e.g., sync issues to Jira, notify Slack when a tester completes)

  • Build custom integrations without polling the API

Getting Started

  1. Get API access enabled: Your BetaTesting account manager will enable the API feature for your company

  2. Create API credentials: Go to your Company Settings > Integrations page to create API keys or OAuth2 clients

  3. Explore the API: Review the interactive API documentation for detailed endpoint specifications

  4. Set up Webhooks: Configure webhook endpoints on the Integrations page to receive real-time event notifications

Managing Credentials & Webhooks

Both API credentials and webhooks are managed through a self-service UI on your Company Settings > Integrations page. You must be a Full Admin on your company account to access this page.

From the Integrations page, you can:

  • Create and delete API clients (static tokens or OAuth2 credentials)

  • View your credentials and copy them securely

  • Create, edit, and delete webhook endpoints

  • Select which events each webhook receives

  • Rotate webhook signing secrets

  • Toggle webhooks on and off

Interactive API Documentation

Full endpoint specifications, including request parameters, response schemas, and example payloads, are available in the interactive Swagger documentation at:

Company Settings > Integrations > View API Documentation

The articles in this help center provide conceptual guides, authentication details, and best practices. For specific endpoint details, refer to the Swagger documentation.

Articles in This Section

  • Authentication: API Keys & OAuth2 - How to authenticate with the API using static tokens or OAuth2 client credentials

  • API Reference Guide: Overview of all available resources and endpoints, pagination, filtering, and best practices

  • Webhooks Overview & Setup: How to configure and manage webhook endpoints

  • Webhook Events Reference: Complete list of webhook events and their payloads

  • API & Webhooks FAQ & Troubleshooting: Common questions and solutions

Did this answer your question?