Search Knowledge Base Articles

Business Intelligence Dashboard — API & Embed (how to use)

← Back to Business Intelligence Dashboard overview

API & Embed

Module: Business Intelligence Dashboard

Where to open in admin

  1. Log in to Admin.
  2. Open sidebar menu Business Intelligence Dashboard.
  3. Click API & Embed.
  4. Direct route (for admins): admin/business_intelligence/business_intelligence_embed_tokens

What this screen is for

Integrate external systems via REST API or outbound webhooks.

How to use — step by step

  1. Enable API in finance settings.
  2. Create API key/token and store securely.
  3. Use Bearer token on requests; add Idempotency-Key on writes.
  4. Configure webhook URL and verify HMAC signatures on receiver.

Common buttons & actions

  • Create key
  • Rotate token
  • Test webhook

Required permissions

Staff need the bi_settings feature with: view, edit.

Assign under Setup → Staff → Roles → Permissions.

Tips from module settings

  • Use this URL in an iframe on allowed domains.

Related guides

See the Business Intelligence Dashboard overview for module-wide workflows, API, and setup.

Did you find this article useful?

Related Articles