Home Nimbus Administration Configuration (Admin) Instant Messaging

Provider Connectors

Provider Connectors are configuration items that define the connection and authentication of Nimbus with external communication providers. The goal is to leverage external APIs, allowing communication between external customers and internal Nimbus services.

✅PRECONDITIONS

💡The current implementation relies on https://www.twilio.com/ as external service. To set up this configuration entity correctly, you need:

A working Twilio account.
A Twilio messaging service either for WhatsApp or SMS¹.
An API Key SID and API Key Secret from your Twilio account, which allows Nimbus to connect and communicate with your Twilio service.

¹🔎 More details can be found under Use Case - Setting Up Instant Messaging, following the WhatsApp / SMS setup instructions accordingly.

Field	Description
Name	Name of the Provider Connector.
Organization Unit	Organization Unit placement of the Provider Connector.
Type	💡Currently locked to Twilio as selection. → Visit: https://www.twilio.com for more information.
API Key SID	🔎 Twilio API Documentation: Use the Key resource to create and manage Standard and Restricted API keys. The SID is a unique string created to identify the Key resource. Regex Pattern: `^SK[0-9a-fA-F]{32}$` Length: 34 characters 💡Example for a valid SID `SK12345678900000000000000000AbCdEf` Ensure you only paste the (limited scope) API Key SID, not your entire Twilio account SID in Nimbus. The latter would grant access to your entire Twilio account. 🔎 From the Twilio Documentation: What is a Twilio Account SID and where can I find it? *NOTE: it’s very important to keep your Account SID and Auth Token hidden. Do not commit it anywhere, as someone can access your full project if they have your Account SID and Auth Token (which acts as a username & password) shown above.
API Key Secret	💡A field for the API secret, created when you create a new API Key resource in Twilio. This unique key can be up to 256 characters in length. ☝Store the secret in a secure location, because you won't be able to retrieve it again. Twilio uses the Key resource's `SID` and the `Secret` as the credentials when making API requests.
Region	The list of regions that Twilio supports: United States (required¹) Ireland (not supported for WhatsApp: See Twilio API available Features) ¹☝Note: Data Residency From the Twilio Documentation: Twilio Regions Twilio Regions are isolated data centers around the world where Twilio performs the processing and storage required to enable your application's communications activities. Twilio's default Region is located in the eastern United States (US). If you are operating your application or serving a customer base in a different part of the world, you might be aware that relying on Twilio's US-based infrastructure can result in serious business challenges such as: Severe latency due to the geographical distance between your application and Twilio Unmet data residency requirements.