Skip to main content

Connect Integrations and Add Your Own Fields

API keys let trusted systems connect to Brixi; custom fields let you capture the contact data your business actually needs. Both live here, and both deserve care — they affect integrations, CRM records, and workflow rules.

Entry pointAdmin → System

Use Developer for API keys. Use Custom Fields for CRM field groups and contact fields.

Who can do this?

CRM admins and account admins with system access can manage these settings. API keys should only be created for trusted integrations.

Generate an API key

  1. Open Developer.
  2. Click Generate key.
  3. Copy the token when it is shown.
  4. Store it in your secure integration tool.
  5. Revoke unused keys immediately.

Tokens are only visible once when generated. Do not share API keys in chat, tickets, screenshots, or documents.

Manage custom fields

  1. Open Custom Fields.
  2. Review existing field groups such as Contact Information or Social Media Information.
  3. Click Add Group when you need a new custom group.
  4. Open a group and click Add Field to add a field.
  5. Use Reorder when you need to change display order.
  6. Activate or deactivate custom groups and fields based on workspace needs.

What you should see after finishing

API keys should appear in the API Keys list after generation. Custom field groups should show field count, group type, display order, and active status.

Common issues

  • API key is lost: Generate a new key and revoke the old one if needed.
  • Custom field does not appear on records: Confirm the group and field are active.
  • Workflow cannot use a custom field: Confirm the field exists for the correct CRM object and has been saved.

Troubleshooting

Lost API keys aren't recoverable — tokens show only once — so don't ask support to retrieve one. Generate a new key and revoke the old. Do contact support if key generation fails outright, or if a custom field is active but still missing from records or unreadable by workflows; name the field, its group, and the CRM object.

One more thing: never paste an API key into a ticket. Support doesn't need it, and it shouldn't live in chat history.

Was this article helpful?If something is unclear or out of date, email support@brixi.ai with the article title — or see Getting Help for what to check first.