Get started with CPaaS X

Set up CPaaS X to manage communications for multiple customers from a single Infobip account. Create applications to organize your communications and entities to represent your customers.

Prerequisites [#prerequisites]

To use CPaaS X, you need:

• Main account: CPaaS X is not available for subaccounts
• Infobip account: Log in or register for an account to access CPaaS X
• Enabled communication channels: The channels you plan to use must be enabled for your account
• API key: Create an API key with the correct permissions for your application

Learn more

Read API authentication for general API key setup, or Manage API keys for CPaaS X scoped keys that restrict access by application, entity, and channel.

Your platform structure [#your-platform-structure]

CPaaS X organizes your communications around two core concepts:

• Applications: Represent your environments or use cases (for example, production, staging)
• Entities: Represent your customers or business units (for example, customer-a, customer-b)

Your multi-tenant platform will look like this:

Create your first application and entity [#create-application-and-entity]

Create your first application and entity using the web interface or API. For detailed steps, see Manage applications and entities.

1. Create an application: Use an ID that represents your environment or use case (for example, production, staging, marketing-campaigns)
2. Create an entity: Use an ID that represents your customer or business unit (for example, customer-a, customer-b)

After creating both, your basic tenant structure is ready. Repeat entity creation for each customer you onboard.

Verify your setup [#verify-your-setup]

Confirm that your application and entities were created successfully.

Your application and entities are ready.

Send your first message [#send-your-first-message]

CPaaS X works with all supported channel APIs. Include applicationId and entityId in the options.platform object so CPaaS X attributes the message to the correct tenant.

This example sends an SMS using the application and entity you created in the previous steps. Replace the following placeholders with your own values:

• {baseUrl}: Your base URL
• {apiKey}: Your API key
• {senderName}: A sender registered on your account (for example, an alphanumeric sender ID or phone number)
• {recipientNumber}: The phone number to send to (for example, 441134960001)

A successful response returns a 200 OK status. For the full request and response schema, see the SMS API reference.

Check delivery and entity attribution [#check-delivery-and-entity-attribution]

After sending the message, verify that it was attributed to the correct entity. CPaaS X provides two levels of visibility: real-time webhook notifications and per-message logs.

Webhook subscriptions [#webhook-subscriptions]

The recommended approach for delivery tracking. Subscribe to delivery events per entity using webhook subscriptions, which support filtering by applicationId and entityId. Events are pushed to your endpoint in real time, with no polling required.

Message logs [#message-logs]

If you need synchronous verification, use the SMS logs endpoint with entityId and applicationId as query parameters to retrieve messages for a specific tenant. Each log entry includes a platform object that confirms entity attribution. Logs may take a few moments to appear after sending.

Aggregated traffic data [#aggregated-traffic-data]

For usage dashboards and traffic analysis, use the Metrics API to query aggregated traffic data. Use APPLICATION_ID and ENTITY_ID (Metrics API dimension names) as grouping dimensions to break down message volumes and delivery rates per tenant across all channels.

You can also use the Analyze section in the Infobip web interface for visual dashboards with application and entity filtering, without writing code.

Learn more

Read Metrics and reporting for a full overview of scoped reporting options, including the Metrics API, Analyze dashboards, and event subscriptions for real-time notifications.