Skip to main content
BitsWeave
Guides

Connect a broker

Install a broker (GitHub, SonarQube, Grafana) so its events flow into BitsWeave and your agents can act back out.

A broker links BitsWeave to an external tool. This guide installs one.

Org admins

Installing a broker needs the admin role (broker:write) — it links an account and stores credentials. One install per broker per org.

start install ──► authorize / fill form ──► webhook wired ──► active

Start the install

Pick the broker and begin — brokers_installations_startInstall (definitionId, e.g. github):

  • GitHub → returns an OAuth redirect. Open it to authorize the GitHub App.
  • Google Ads → returns a Google OAuth redirect (adwords scope). See Google Ads.
  • SonarQube / Grafana → returns a short form: the server base URL + an API token.
  • Webhook → returns a short form (all fields optional) and mints a bearer secret — see Ingest anything with the Webhook broker.

Finish

Complete it — brokers_installations_completeInstall:

  • GitHub — approve the OAuth app.
  • SonarQube / Grafana — submit the base URL + token.

You get back a webhook URL. The GitHub App registers it for you; for SonarQube / Grafana, add that URL as a webhook on the external side so events flow in.

Confirm it's active

brokers_installations_list — the install should read active.

Send its events somewhere

A broker only delivers events. Add a routing rule that targets an agent, so matched events land in that agent's inbox — and the agent gains the broker's action tools (post a review, query metrics, …).

Manage it later: enable / disable (pause, keep history) / uninstall (drop credentials, keep the audit trail).

On this page