Creating workflows for Twilio users

Let Oomnitza be your single source of truth!

You'll get visibility of your Twilio users as data from Twilio is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Twilio in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows that you can easily create to automate such tasks as:
  • Sending MMS and SMS via Twilio
  • Creating and updating accounts
  • Creating, updating and deactivating Twilio users

Navigation

Adding the credentials

Creating workflows

Creating workflows with the API block

Create Account Resource
Create New End User
Delete End User
Get Account Resource
Get End User
Send MMS
Send SMS
Send SMS with Callback
Update End User

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

Authentication is performed using an API key. You will use your Twilio Account SID as the username and your Auth Token as the password. You can find your Account SID and Auth Token on your Twilio dashboard.

For further information consult the Twilio API documentation: Our API.

Adding the credentials

To stream Twilio user data into Oomnitza, complete the following steps:

1. From the menu, go to Configuration>General.
2. Click Global Settings.
3. Click Add new credential (+).
4. Add the information details.
5. Click the AUTHORIZATION tab.
6. Ensure that Basic is selected as the authorization type.
7. Enter your Twilio Account SID as your username.
8. Enter your Auth token as your password. 
9. Save your changes.

Next

You use the credentials that you added to create and customize your Twilio integrations with Oomnitza.

Creating workflows

Creating workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create workflows with the API block by following the steps in Creating workflows with the API block. To locate the available presets, enter Twilio in the Select Preset search field. Before you start working with these presets, ensure that you have added your Twilio credentials that you created in Adding the credentials

The Twilio API block workflow comes with the following presets:

Create Account Resource
Create New End User
Delete End User
Get Account Resource
Get End User
Send MMS
Send SMS
Send SMS with Callback
Update End User

Using the Create Account Resource Preset

The Create Account Resource preset creates a new account instance resource as a subaccount of the Account SID used to make the request. You need to supply the Friendly name or the name of the account you want to create when using this preset. The Friendly Name defaults to Created at {YYYY-MM-DD HH:MM meridian} if it is not supplied. 

When using this preset, the map to fields are the fields which the following JSON response will be mapped to:

  "status": "active",
  "date_updated": "Thu, 30 Jul 2015 20:00:00 +0000",
  "friendly_name": "friendly_name",
  "owner_account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "uri": "/2010-04-01/Accounts/123456.json",
  "sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "date_created": "Thu, 30 Jul 2015 20:00:00 +0000",
  "type": "Trial",
}

You can specify the field names this response will map to in the following values. For information on creating Oomnitza fields, see Creating Custom Fields in Oomnitza.

• Map Service ID to Field. 
• Map Owner Account ID to Field. 
• Map Friendly Name to Field. 
• Map Type to Field. 
• Map Date Created to Field. 
• Map Date Updated to Field. 
• Map URI to Field. 
• Map Status to Field. 

For troubleshooting purposes, you could also map the entire JSON response to a single field. You can do this using the Advanced Mode feature. 

1. In the API block window, click the Advanced Mode button located in the upper right of the window
2. Select the Response tab.
3. Add {{response}} to the Response field and map this value to a custom long text Oomnitza field. Once you have the entire response, you can then map to individual JSON values to custom fields. For further information, see Creating Custom Fields in Oomnitza.

For additional information, consult the Twilio API documentation: Create an account resource.

Using the Create New End User preset

The Create New End User preset creates a new end user in Twilio. The End-User is the individual or business who answers the phone call or receives the message. When using this preset, the following information is required:

• Business Description.
• Business name.
• Business VAT Number.
• Resource Description. Otherwise known as the Friendly Name - the string that you assigned to describe the resource.
• Type of user. The type of end user of the Bundle resource - it can be individual or business.

Next, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. Select the Body tab. Modify, update or add fields that will be used in the request payload. For example, you might want to add additional attributes to describe the business. For information on the fields that are permitted in the request payload, refer to the Twilio API documentation: Create a new End-User.
3. Select the Response tab. For troubleshooting purposes, you can map the entire response to a custom Oomnitza field as described in step 3 of Using the Create Account Resource Preset.

Using the Delete End User preset

The Delete End User deletes an end user. An Account SID is required to identify and delete the end user. 

Next, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the Account SID is referenced in the a custom field {{serviceid}}. You can create this field and map a value to it in a workflow, or alternatively, you can manually enter a {{serviceid}}to test the preset.
3. Select the Response tab. For troubleshooting purposes, you can map the entire response to a custom Oomnitza field as described in step 3 of Using the Create Account Resource Preset.

For further information, refer to the Twilio API Documentation: Delete an end user instance.

Using the Get Account Resource preset

The Get Account Resource preset fetches a representation of an account. An Account SID is required to identify the account. When using this preset, specify the field names the JSON response will map to, similar to Using the Create Account Resource Preset.

Next, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the Account SID is referenced in the a custom field {{serviceid}}. You can create this field and map a value to it in a workflow, or alternatively, you can manually enter a {{serviceid}}to test the preset.
3. Select the Response tab. For troubleshooting purposes, you can map the entire response to a custom Oomnitza field as described in step 3 of Using the Create Account Resource Preset.

For further information, refer to the Twilio API Documentation: Fetch an account instance.

Using the Get End User preset

The Get End User preset fetches an end user instance. An Account SID is required to identify the end user.  When using this preset, the map to fields are the fields which the following JSON response will be mapped to:

{
"sid": "ITXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"friendly_name": "friendly_name",
"type": "individual",
"attributes": {
"email": "[e-mail]"
},
"date_created": "2019-07-30T21:57:45Z",
"date_updated": "2019-07-30T21:57:45Z",
"url": "https://numbers.twilio.com//XX"
}

You can specify the field names this response will map to in the following values. For information on creating Oomnitza fields, see Creating Custom Fields in Oomnitza.

• Map Service ID to Field. 
• Map Account ID to Field. 
• Map Friendly Name to Field. 
• Map Type to Field. 
• Map Email to Field. 
• Map Date Create to Field. 
• Map Date Updated to Field.
• Map URL to Field.

Next, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the Account SID is referenced in the a custom field {{serviceid}}. You can create this field and map a value to it in a workflow, or alternatively, you can manually enter a {{serviceid}}to test the preset.
3. Select the Response tab. For troubleshooting purposes, you can map the entire response to a custom Oomnitza field as described in step 3 of Using the Create Account Resource Preset.

For further information, refer to the Twilio API Documentation: Fetch an end user instance.

Using the Send MMS preset

The Send MMS preset sends .gif, .png, or .jpeg content to a recipient. An Account SID is required to send the message.

Note
The size limit for message media is 5MB. To send more than one image in a message body, provide multiple MediaUrl values in your POST request (limited to 10 per message).

 When constructing a workflow that uses this preset, the following information is required:

• Number to send to.
• Number to send from.
• Media URL. The URL of the media you want to include in your message. 
• Body of SMS. Limited to 1600 characters.

Next, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the Account SID is referenced in the a custom field {{serviceid}}. You can create this field and map a value to it in a workflow, or alternatively, you can manually enter a {{serviceid}}to test the preset.
3. Select the Response tab. For troubleshooting purposes, you can map the entire response to a custom Oomnitza field as described in step 3 of Using the Create Account Resource Preset.

For further information, refer to the Twilio API Documentation: Send an MMS message.

Using the Send SMS preset

The Send SMS preset sends a full text of the message, limited to 1600 characters. An Account SID is required to send the message. It can be configured in the same manner as the Send MMS preset.

For further information, refer to the Twilio API Documentation: Send an SMS message.

Using the SMS with Callback preset

The SMS with Callback preset sends a full text message, limited to 1600 characters, but also requires a Call Back URL. Twilio makes a post request to this URL, with the status of your message. An Account SID is required to send the message. It can be configured in the same manner as the Send MMS preset.

For further information, refer to the Twilio API Documentation: Send an SMS with callback.

Using the Update End User preset

The Update End User preset updates an end user instance. An Account SID is required to update the end user. When constructing a workflow that uses this preset, the following information is required:

• Email.
• First Name.
• Friendly Name. The string that you assigned to describe the resource.

Next, use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the Account SID is referenced in the a custom field {{sid}}. You can create this field and map a value to it in a workflow, or alternatively, you can manually enter a {{sid}}to test the preset.
3. Select the Response tab. For troubleshooting purposes, you can map the entire response to a custom Oomnitza field as described in step 3 of Using the Create Account Resource Preset.

For further information, refer to the Twilio API Documentation: Update an End-User.

For further information on workflows see:
 Understanding workflows
 Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.