BNex documentation

BNex documentationAccount and developer tools

Account and developer tools

API keys, webhooks, and workspace data

BNex Advanced Settings groups API keys, outgoing webhooks, contact exports, imports, and workspace JSON exports under Developers & Data.

Updated 2026-10-12

Open Developers & Data

  1. Open the active workspace’s Settings. Confirm that you are configuring the intended business workspace.
  2. Switch to Advanced Settings. Use the Settings page switcher to open the Advanced area.
  3. Choose the Developers & Data task. Open API keys, webhooks, or the data tool you need. BNex discloses API examples and webhook guidance within the relevant control.

Create and protect an API key

Create an API key only for a client or integration that needs BNex API access. Follow the scopes, usage instructions, and example shown by the current Developers & Data UI; do not guess an authorization header or endpoint from an unrelated integration.

Copy a secret only into the intended secret store for the integration. Never put it in browser code, a public repository, a screenshot, a shared support message, or a URL. If a key is lost or exposed, revoke it and create a replacement.

Configure an outgoing webhook

Use an outgoing webhook when an external system needs to receive supported BNex events. Configure the destination in Advanced Settings and use the event and verification guidance displayed there.

Start with a test destination you control. Keep the destination private, verify webhook authenticity according to the instructions BNex provides, and avoid logging customer message bodies or credentials in the receiver.

Import and export workspace data

  • Contact list import accepts CSV, Excel, and vCard files and provides a preview before commit.
  • Contacts can be exported as CSV.
  • Workspace JSON export includes contacts, messages, templates, and workflows, including workflow nodes and edges.
  • Exports may contain personal or business-sensitive information. Store them securely, limit access, and delete them when no longer needed.

Frequently asked questions

Where do I find a BNex API example?

Open the relevant API key control in Advanced Settings → Developers & Data and disclose its built-in example. Use that example and the current BNex API guidance rather than guessing routes or headers.

What is included in workspace JSON export?

The documented workspace JSON export includes contacts, messages, templates, and workflows, including workflow nodes and edges. Contact CSV export is available separately.

Related guides