Reference

Infobip

Infobip is a global cloud communications platform that provides a wide range of communication and customer engagement solutions for businesses.

Infobip is a global cloud communications platform that provides a wide range of communication and customer engagement solutions for businesses.

Category: Communication. Adds 3 actions to a care flow.

What to configure

Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.

SettingRequiredNotes
API keyYesYour Infobip API key Stored as a secret.
Base URLYesYour unique API base URL
From emailYesThe email address you wish to use for sending text messages. When you are using Broadcast templates, the from email defined in the template will be used.
From phone numberYesThe phone number you wish to use for sending text messages, must be in E.164 format (eg. +19033428784)

Actions

Infobip adds these 3 actions to a care flow. Add one to a step, then fill in its inputs.

Send email

Sends email using Infobip

This action can be previewed in Studio before you publish.

InputTypeRequiredDescription
FromstringNoThe email address you wish to use for sending emails. Defaults to value provided in settings.
TostringYesThe email address to which you intend to send the email
SubjectstringYes
ContenthtmlYes

Sends a simple email to a recipient.

Send email with template

Sends email with a template using Infobip

This action can be previewed in Studio before you publish.

InputTypeRequiredDescription
TostringYesThe email address to which you intend to send the email
SubjectstringNoWhen provided, it overwrites the subject specified in the Broadcast template
Template IDnumericYesThe ID of the template used for generating email content
PlaceholdersjsonYesThe values for the placeholders defined in your template. Must be a valid key-value pair JSON object.

Send an email, using a template, to a recipient. You need to create a Broadcast email template as that is the only type of template supported by Infobip's API. Templates can be created and managed via the Infobip web portal.

When using this action, the from/sender details and subject as specified in the template will be used. However, you can specify a subject if you would like to overwrite the subject specified in the template.

Within your template, you can harness placeholders using Infobip's {{ syntax. This feature allows you to craft templates with both static and dynamic content. You can determine the dynamic content's value when configuring the action in Awell Studio. For instance, if your template includes two placeholders, {{variable_1}} and {{variable_2}}, you can provide the following data in the placeholders action field to set values for these placeholders:

{
  "variable_1": "Hello",
  "variable_2": "World"
}

Send SMS

Sends SMS using Infobip

This action can be previewed in Studio before you publish.

InputTypeRequiredDescription
FromstringNoThe phone number you wish to use for sending the text message. Defaults to value provided in settings.
TostringYesThe phone number to which you intend to send the text message
ContenttextYesThe content of the message being sent

Send a text message to a recipient.

Setup and notes

Infobip is a global cloud communications platform that provides a wide range of communication and customer engagement solutions for businesses. The company offers a suite of services and tools designed to help organizations connect with their customers, clients, and partners through various communication channels, including SMS, email, voice, chat apps, and more.

Extension settings

In order to set up this extension, you will minimally need to provide:

  1. Your unique API base URL
  2. An API key

When utilizing the Infobip extension for sending emails and text messages, you'll need a 'from email' address and a 'from phone number' respectively.

Where this page comes from

The settings, actions, inputs, outputs and webhooks above are generated from the extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.

On this page