How to use IBM App Connect with ClickSend
ClickSend is a cloud-based business communication software that allows companies to send and receive SMS, email, voice, fax, and post worldwide.
App Connect
Enterprise as a Service connector-
Local
connector in containers (Continuous Delivery release) 12.0.12.0-r1 or later -
Local connector in containers (Long Term Support Cycle-2 release)
Connecting to ClickSend
Complete the connection fields that you see in the App Connect Designer page or flow editor. If necessary, work with your ClickSend administrator to obtain these values.
The following table contains descriptions of the connection fields.
| Connection field | Description |
|---|---|
| Server URL | Select the URL for the API server that makes runtime calls. |
| Username | Specify a username that is authorized to access ClickSend. |
| API key | Specify the unique API key that identifies the API client. |
| Allow self-signed certificates | Set to true or false. Set to true if you want to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. The default is false. |
| Override server URL | Required if you want to connect to an endpoint in a private network by using the private
network client, or if you want to override the server URL. Specify an override value for the host
and port for the connector in the format <http or
https>://<host_name>:<port>. If you are not using the private network client or do
not require an override, leave this field blank. |
| Private network connection |
Select the name of a private network
connection that App Connect uses to connect to your private
network. This list is populated with the names of private network connections that are created from
the |
To obtain the connection values for ClickSend, see Obtaining connection values for ClickSend.
To connect to a ClickSend endpoint from the App Connect Designer Applications and APIs page for the first time, expand ClickSend, then click Connect.
General considerations
Before you use App Connect Designer with ClickSend, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and Actions
ClickSend events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.
ClickSend actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Accounts | Retrieves account information | Retrieve account information |
| Allowed emails for SMS communication | Retrieve allowed emails for SMS communication | Retrieves list of email to SMS allowed addresses |
| Create allowed email for SMS communication | Creates email to SMS allowed address | |
| Contact lists | Retrieve contact lists | Retrieves all contact lists |
| Create contact list | Creates a new contact list | |
| Retrieve contact list by ID | Retrieves specific contact list | |
| Contacts | Retrieve contacts by list ID | Retrieves a specific contact using contact list ID |
| Copy contact to contact list | Copies contact to another list | |
| Create contact in contact list | Creates a new contact in a contact list | |
| Transfer contact to contact list | Move contact to another list | |
| SMS | Retrieve SMS delivery receipts | Retrieves all delivery receipts |
| Cancel scheduled SMS | Updates scheduled message as cancelled | |
| Send SMS message | Sends SMS message(s) | |
| SMS campaigns | Retrieve SMS campaigns | Retrieves a list of SMS campaigns |
| Cancel SMS campaign | Cancels an SMS campaign | |
| Create SMS campaign | Sends an SMS Campaign | |
| Voice messages | Retrieve voice message history | Retrieves all voice history |
| Send voice message | Sends TTS (Text-to-speech) voice calls |
Examples
Use templates to quickly create flows for ClickSend
Learn how to use App Connect templates to quickly create flows that complete actions on ClickSend. For example, open the Templates gallery, and then search for ClickSend.
Use IBM App Connect to build flows that integrate with ClickSend.
Read the blog in the IBM Community to learn how to send a voice message through ClickSend for each new form entry created in Wufoo. Click Read the blog to go to the blog.