Private Integrations

Private Integrations

Automate SMS, calls, and events using our API. With our integration tools, you can securely connect your account with third-party applications, CRMs, or custom systems to send messages, trigger calls, and handle events automatically.

Automate SMS, calls, and events using our API. With Integration Credentials, you can securely connect your account with third-party applications, CRMs, or custom systems to send messages, trigger calls, and handle events automatically.


Integration Credentials

Integration Credentials are your access tokens that allow external apps to interact securely with your account. You can use them to:

  • Send SMS

  • Trigger calls

  • Receive events via webhooks


Key Benefits

  • Simplicity: Generate credentials from your account settings and manage them easily.

  • Security: Restrict permissions (scopes) that third-party apps can access.

  • Control: Rotate or revoke credentials at any time.


How to Use Integration Credentials

Use your credentials in the Authorization header of API requests, just like any access token.

Example: retrieve SMS webhooks:

 
curl --request GET \ --url https://api.zonitel.com/api/v3/integrations/sms/webhooks \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <YOUR INTEGRATION CREDENTIAL>' \ --header 'X-Client-Id: <YOUR CLIENT ID>'

Who Can Create Integration Credentials?

By default, all account administrators can create and manage credentials.


Where to Find Integration Credentials

  1. Go to Administration → Integrations.

  2. Select Config under Automation & Integrations.

  3. Then, in the left-hand menu, you will find the Credentials Section.

How to Create a New Integration Credential

Step 1: Click Create New Credential.
Step 2: Provide a description to identify its purpose.
Step 3: Copy the generated credential and share it only with trusted developers.

Note: Do not share credentials publicly. Copy it immediately; it cannot be retrieved later.


Best Practices

  • Rotate your credentials every 90 days for security.

  • Only share with trusted developers or systems.

  • Revoke compromised credentials immediately.


How to Rotate a Credential

  1. Go to Credentials Section.

  2. Select the credential you want to rotate.

  3. Click Rotate CredentialContinue to confirm.

  4. Copy the new credential and update your external applications.

Note: Once rotated, the old credential stops working and cannot be retrieved.


My Credential Has Been Compromised

  1. Go to Credentials Section.

  2. Select the affected credential.

  3. Click Rotate Credential NowContinue to confirm.

  4. Update your external applications immediately with the new credential.

Note: Copy the new credential immediately; it cannot be retrieved later.


How to Delete a Credential

If the external application is no longer in use:

  1. Go to Credentials Section.

  2. Select the credential and click Delete.


Webhooks

Receive real-time updates for SMS and calls via webhooks:

  • SMS Webhooks: Notifications when SMS are sent, delivered, or failed.

  • Call Webhooks: Updates on call status, recordings, and events.

Was this article helpful?

Still Have Questions?

Our support team is available 24/7 to help you get started

Chat with us on WhatsApp