Skip to content

Integrations

Where: Integrations in the Administration group, /app/integrations.

What it answers: which systems and apps act for our organization, and are they working?

The top of the page shows how each integration is doing: OK, needs attention, or not set up.

API keys

Keys for the API, the Python SDK and the local MCP server.

  • Make a key: a label, access (Read, or Read and write) and an optional expiry in days (30, 90 or 365, or no expiry). The key starts with bs_live_ and is shown once: copy it then. BreachSpider keeps only a hash of it.
  • The list shows each key's label, start of the key, access, last used, expiry, device checks this month (of its allowance) and whether batch jobs are enabled.
  • Revoke stops every call that uses the key at once. It cannot be undone.
  • Batch webhook secret (keys with batch jobs): make or rotate the secret that signs batch.completed deliveries. It is shown once; after a rotation the previous secret keeps working for 24 hours.

Keys are managed only from a signed-in browser: an API key can never create or revoke keys.

Partner keys are issued by BreachSpider. Partner accounts see this screen only, with view-only widget settings.

Connected apps

Apps you connected by signing in, such as Claude or ChatGPT through the Hosted MCP. Each acts for this organization with the access you approved:

Access Meaning
Device and CVE checks Run device checks, change checks, Windows checks, CVE lookups and catalog searches
Batch jobs Submit and read batch jobs
Stays connected The app may refresh its access without asking you again

The list shows the app, whether it is verified, its access, who approved it, when it was last used and when it ends if unused. Revoke stops it at once; it has to be connected again.

The screen shows the address to connect by URL when connecting by URL is open for your organization, or says it is not open yet (use the local MCP server with an API key until then).

Webhooks

Alerts sent to your own HTTPS endpoint when something new applies to your devices, optionally for one site. Each delivery is signed with an X-BreachSpider-Signature header made from the raw body and your secret. Send a test, turn on or off, rotate the secret, delete, and the delivery history (when, what, result, attempt; delivered and failed in the last 30 days). Webhooks are part of the Professional plan and above. How to check a signature: Webhooks.

Partner widget

For partners embedding the device check on their own website: allowed website origins, the per-minute check limit, attribution, the API key it is billed to, and widget keys with their mode (sample devices only, or customer devices), device limit and checks this month. See Partner widget.

Guides and packages

Install
Python SDK pip install breachspider (PyPI)
Local MCP server pipx install breachspider-mcp (PyPI)
Developer guide breachspider.com/developers