> ## Documentation Index
> Fetch the complete documentation index at: https://battletest.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Integrations & API

> BattleTest integrations — signed outbound webhooks for findings and scan runs, the GitHub status check for PR merge gating, and the upcoming REST API.

BattleTest integrates with your existing tooling through two mechanisms available today, with a REST API on the roadmap.

## Outbound webhooks

BattleTest sends signed webhook payloads to any HTTP endpoint you configure when findings are created or scan runs complete. Webhooks are the primary way to push BattleTest data into your own systems — Slack alerts, PagerDuty incidents, ticketing systems, SIEMs, custom dashboards.

**Available on:** Dev plan and higher.

* **To wire one up:** [How to send findings to external tools](/docs/how-to/send-findings-to-external-tools)
* **Payload schema, events, signatures, retries:** [Outbound Webhooks reference](/docs/reference/webhooks)

## GitHub status check

Every PR review sets a `battletest/security-review` commit status check on the PR. Use it as a required check in GitHub branch protection rules to block merges until the security review has completed.

The check reports `success` when the risk score is below 40, `action_required` at 40 or higher ("request changes"), and `failure` only on an internal review error. On its own it blocks nothing; add it as a required status check to gate merges on risky PRs. See [How to require security review before merging](/docs/how-to/require-security-review) for setup. No CI config, no runner minutes, no GitHub Actions dependency.

## REST API — coming soon

A REST API is in development and will support:

* Triggering PR and live scan runs programmatically
* Querying findings, scan history, and risk score trends
* Managing targets, repository connections, and settings
* Bulk export of finding data

To be notified when the API is available, email [wale@battletest.dev](mailto:wale@battletest.dev).