Skip to main content

OPBX Configuration

This guide explains how to configure Cloudonix integration settings in the OPBX admin interface.

Accessing the Settings Page​

  1. Log in to OPBX as an Owner or Admin
  2. Navigate to Settings in the main navigation
  3. Look for the Cloudonix Integration section
Owner Access Required

Only organization owners can access and modify Cloudonix settings. This is a security measure to protect sensitive API credentials.

Settings Fields Explained​

Domain UUID​

Field: domain_uuid
Required: Yes

Your Cloudonix Domain UUID. This uniquely identifies your Cloudonix account.

  • Format: UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • Source: Cloudonix Portal → Settings → Domain UUID

Domain API Key​

Field: domain_api_key
Required: Yes

The API key that OPBX uses to authenticate with Cloudonix.

  • Length: Typically 32+ characters
  • Format: Alphanumeric string (often starts with XI)
  • Source: Cloudonix Portal → Settings → API Keys

Domain Name​

Field: domain_name
Required: No (auto-populated)

Your Cloudonix domain name. This is typically auto-populated when you validate your credentials.

  • Example: yourcompany.cloudonix.net
  • Source: Cloudonix Portal → Settings → Domain Settings

Requests API Key​

Field: domain_requests_api_key
Required: No (recommended)

The API key used to authenticate webhooks sent from Cloudonix to OPBX.

  • Purpose: Provides additional security for incoming webhooks
  • Recommendation: Enable this for production environments

Webhook Base URL​

Field: webhook_base_url
Required: Yes (for production)

The base URL where OPBX receives webhooks from Cloudonix.

  • Local Development: Use ngrok to expose your local server
  • Production: Your public-facing domain
  • Format: https://your-domain.com (no trailing slash)

Setting Up for Local Development​

For local development, you'll need to expose your local OPBX instance to the internet:

# Using ngrok (run in separate terminal)
ngrok http 80

# Note the HTTPS URL provided by ngrok
# Example: https://abc123.ngrok-free.app

Enter this URL in the Webhook Base URL field.

No Answer Timeout​

Field: no_answer_timeout
Required: Yes
Default: 60 seconds
Range: 5-120 seconds

How long Cloudonix should ring an extension before considering it "no answer."

  • Lower values: Faster failover to voicemail/next destination
  • Higher values: More time for user to answer

Recording Format​

Field: recording_format
Required: Yes
Options: mp3, wav
Default: mp3

The audio format for call recordings.

FormatQualityFile SizeUse Case
mp3GoodSmallerGeneral use, storage efficiency
wavExcellentLargerHigh-quality requirements

Security Considerations​

API Key Handling​

  • Never commit API keys to version control
  • API keys are encrypted at rest in the database
  • Display shows masked values (e.g., XI12***abcd)

Webhook Authentication​

We strongly recommend enabling webhook authentication:

  1. Generate a Requests API Key in Cloudonix
  2. Enter it in the Requests API Key field in OPBX
  3. OPBX will verify the Bearer token on incoming webhooks

This prevents unauthorized calls to your webhook endpoints.

Configuration Status​

After saving, OPBX displays the configuration status:

  • Configured: Settings are saved and credentials are valid
  • Not Configured: Missing required fields
  • Invalid Credentials: API key or UUID is incorrect

Viewing Current Settings​

The Settings page shows your current configuration:

  • Domain UUID (full)
  • Domain Name (if set)
  • API Keys (masked)
  • Webhook URLs (generated)
  • Package information

Next Steps​

Now that you understand the configuration fields, proceed to Pairing Workflow for the step-by-step process.

Related Documentation: