Configuring a notification API
 |
 |
Prerequisites
- SoftExpert Copilot as part of the solutions acquired by the organization.
- SoftExpert Suite environment hosted in the cloud.
- Previously configured integration API (Zenvia or Twilio).
- Access to the Configuration > Integration center (COP010) menu.
Introduction
The Notification tab of the Integration center in Copilot is used to configure the API responsible for sending messages via SMS or WhatsApp.
This article will cover the procedure for configuring a notification API, as well as practical examples of this feature being applied in SoftExpert Suite.
Configuring a notification API for sending SMS
1. To set it up, access the Configuration > Integration center (COP010) menu.
2. Click on the Notification tab.
3. In the SMS grouping, select the desired API in the corresponding field.
4. Clique on 
.
5. After saving, the system will return to the Integration API tab. Access the Notification tab again and make sure that the Enable sending through this channel option is properly checked, so that the notification is sent through the specified API.
6. Click on .
Webhook links for status update and message receiving will be displayed, which can be used as needed.
Configuring a notification API for sending messages via WhatsApp
1. To set it up, access the Configuration > Integration center (COP010) menu.
2. Click on the Notification tab.
3. In the WhatsApp grouping, select the desired API in the corresponding field.
4. Clique on .
5. After saving, the system will return to the “Integration API” tab. Access the Notification tab again and make sure that the Enable sending through this channel option is properly checked, so that the notification is sent through the specified API.
6. Click on .
Webhook links for status update and message receiving will be displayed, which can be used as needed.
Billing for sent messages is the responsibility of the Zenvia or Twilio sending platform.
Practical applications
Below, see practical examples of notification application in SoftExpert Suite components:
- SoftExpert Survey: sending of automatic messages via SMS and WhatsApp, ensuring that the participants are reminded to answer the surveys.
- SoftExpert Business rule: sending of SMS messages to pass on information for situations in which e-mail cannot be used.
Conclusion
With the notification API configured, the feature can be used in the SoftExpert Suite components, enabling the automated sending of messages via SMS and WhatsApp.