Dela via


DataMotion (Preview)

DataMotion, Inc. specializes in secure data exchange APIs, allowing companies to integrate secure message and file exchange solutions into their existing workflows and save development time. Following security protocol can be time-consuming, but DataMotion's connector enables seamless, one-way encrypted messaging, helping users remain compliant with industry regulations and your enterprise's security policies.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name DataMotion Support
URL https://datamotion.com/support-request/
Email support@datamotion.com
Connector Metadata
Publisher DataMotion, Inc.
Website https://datamotion.com/secure-message-delivery-api/
Privacy policy https://datamotion.com/privacy-policy/
Categories Communication;Security

DataMotion, Inc. is an API company specializing in secure data transfer. This means that you can utilize our secure message delivery connector to securely send encrypted text, documents, images, files and more to any user with a valid email address. With this end-to-end encryption, you can be sure the content of your messages hasn’t been taken offline or altered in any way, whether while in transit or in your inbox. In addition to securely sending messages, the secure message delivery connector allows you to track and retract secure messages. By integrating this functionality into your workflows, your users will be able to securely automate tasks that may have been completely out of the question before, as automation may have jeopardized security. Your organization will be able to leverage Power Automate for automating a myriad of tasks, including the proper, secure handling of clinical information, transferring patient health records, transferring payment stubs, storing employee retirement plans, and more.

Prerequisites

To utilize DataMotion’s secure message delivery connector, you will first need to create a DataMotion account. You have the option to create a paid, subscription-based account, or a free 30-day trial to start. To create an account, navigate to datamotion.com/portal.

Once you have completed this step, you will automatically receive a $25 credit to test the API. From here, you can select ‘Payments’ to continue to add to your balance in the form of a one-time or recurring payment. You will need a balance in order to continue sending, tracking and retracting secure messages with the secure message delivery connector.

How to get credentials

To create a DataMotion account, navigate to datamotion.com/portal where you will see a list of API plans displayed. Hover over the ‘secure message delivery’ plan and click the ‘Try Now’ icon.

Once you have selected ‘Try Now’ you will see the ‘API – secure message delivery Self-Service Center’ page displayed. This center provides the option to test the DataMotion APIs, review documentation and contact support if needed.

In the top right corner of the screen there is a ‘Login’ button. Click this button to get started. A new pop up will display once the button is selected; at the bottom of this pop up, select ‘sign up here.’

After you have completed these steps, you will see a request for information and a section to create a password. Enter the required information and create your secure password.

Review and agree to the terms of service, then finish the process by selecting ‘Create Your Account.’ There you have it! Your account has been created and you will automatically have a $25 balance to test our APIs.

Get started with our connector

DataMotion’s secure message delivery is a perfect addition within automated workflows. The connector itself cannot be used as a trigger, but can be used to send, track and retract secure messages once your workflow is ignited.

There are a few common triggers for workflows utilizing the secure message delivery connector. A form submission is one example, as users may need to pull sensitive data from a form then send it along in a secure manner. Signing a form using the DocuSign connector will also be a common trigger. Important documents that need to be signed and passed along are often business-critical, or contain PII, PHI or PCI and therefore should be sent securely. Finally, a timed interval can be used to trigger a workflow on a daily, weekly or monthly basis. This is especially useful when important data, such as an updated customer account list or weekly profit review, needs to be encrypted and sent to a third party on a regular basis.

To get started with the secure message delivery connector, first create a new Power Automate workflow and select a trigger. You can utilize one of the examples above or a more unique trigger.

Once a trigger is selected, you will need to add the sensitive data you wish to send. For example, if you choose a form submission as a trigger, the first step in the workflow will be to collect the data from this form. Once you have gathered sensitive data through your workflow, the next step is to send the data through a secure message. In order to do this, you will need to add an additional workflow step.

To do this, select ‘+ Next Step’ and search for the DataMotion connector. You can do this by typing ‘secure message delivery’ in the search bar at the top of the new step section.

Once you have selected the ‘+ Next Step’ button, you will see a list of actions associated with this connector. Choose ‘Send Secure Message’ as the action.

A new widget will display the secure message request.

Below, I will walk through each section of the request and provide example entries. Keep in mind you may need to customize these fields to properly test (especially the ‘To’ address!).

  • Version

    • V– this section is asking for the version of the DataMotion API you are using. You can find the version of the API you are using in the ‘How Do I’ section of our self-service portal. At the top of the ‘Required Parameter’ section you can find the API version.
  • X-API-Secret

    • To get the API secret key, navigate back to the self service center and sign in. Once you have signed in, a new tab should appear titled ‘Applications.’ Select this tab.
      • From here, select the ‘Create Application’ button and give the application a name. Then select ‘Other’ for the Application Type and provide a description.
      • Select the ‘plus’ sign (+) in the center of the API Keys section and copy the API Secret that is provided in the pop up. Paste this key into the X-API-Secret text box in Power Automate.
  • X-API-Key

    • In the API Key section, copy the key provided and paste it in the X-API-Key section in Power Automate.
  • From

    • The ‘From’ address will be the address you are sending the secure message from. Enter in the address with which you created the API Secret and Key.
  • To

    • The ‘To’ address can be any address with a mailbox. To test, you can enter the same address you used for the from address or any address you have access to.
  • Cc (Optional)

    • Enter any additional email address that have a corresponding mailbox you would like copied.
  • Bcc (Optional)

    • Enter any additional email address that have a corresponding mailbox you would like to blind copy.
  • Subject (Optional)

    • Enter the subject of the email.
  • Attachments (Optional)

    • To add an attachment, you will need to provide the base64 string, content type, file name and content ID. There are a few additional steps to gather this information automatically, but for the demo today, you can leave this section blank.
  • HtmlBody (Optional)

    • In this section, you can add html text to send in the body of the message. For this example, you can keep this section blank.
  • TextBody (Optional)

    • In this area, outline the body in plain text and add the sensitive information you would like to send.

When clicking in each of the textboxes, you may see ‘Insert parameters from previous step.’ These parameters you see suggested are the responses you may have previously pulled from either a form, Excel sheet, or another sensitive document. You can select these parameters to include this data in the body of the email.

Once you have finalized your configurations, select ‘Save.’ You will see a message confirming your workflow has been saved at the top of your screen.

Now you have created a workflow that incorporates the DataMotion secure message delivery API!

Known issues and limitations

DataMotion’s secure message delivery connector has one known limitation. If a user tries to track or retract a message directly after sending it, an error message may appear indicating the message could not be found. This is because the message ID has not yet been updated. A two-second delay or retry on failure will resolve this issue.

Common errors and remedies

An invalid API secret or key will result in a 401 error. To resolve this error you need to create a new key. Navigate to the DataMotion secure message delivery portal and select the Applications tab. In this tab you will see an API Key section with your current API key display. Delete your current API key with the trash icon located to the right of the key.

Once the trash icon is selected, the key will be removed and a new option to add a key will be available in the middle of the API Key section of the page. Select this option and securely save the secret key (that you will see displayed) as you will not be able to access this key again from the DataMotion portal. From here, copy your new API key into your Power Automate workflow.

FAQ

Where do I get an API key and secret?

To create an API key or secret, navigate to the DataMotion secure message delivery portal and select the ‘Applications’ tab. In the ‘API Key’ section, an option to add a key will be available; you will see the option in the middle of the section. Select this option and securely save the secret key that will be displayed, as you will not be able to access this key again from the DataMotion portal. From here, copy your new API key into your Power Automate workflow.

How do I sign up for a DataMotion account?

To sign up for a DataMotion account, navigate to datamotion.com/portal where you will see a list of API plans displayed. Hover over the ‘secure message delivery’ plan and click the ‘Try Now’ icon.

Once you have selected ‘Try’ you will see the ‘API – secure message delivery Self-Service Center’ page displayed. This center provides the option to test the DataMotion APIs, review documentation and contact support if needed.

In the top right corner of the screen there is a ‘Login’ button. Select this button to get started. A new pop up will display once the button is selected - at the bottom of this pop up select ‘sign up here.’

After you have completed these steps, you will see a request for information and a section to create a password. Enter the required information and create your secure password.

Review and agree to the terms of service, then finish the process by selecting ‘Create Your Account.’ There you have it! Your account has been created and you will automatically have a $25 balance to test our APIs.

How do I add to my balance?

To add to your balance, navigate to the DataMotion secure message delivery portal and select ‘Payments’ under your available balance. Provide your name, company and address then hit ‘Next.’ From here, you can set up a recurring payment that will refill automatically; you also have the option to make a one-time payment.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Retract a Secure Message

Retract a secure message that was previously sent.

Send a Secure Message

Sends a message in a secure manner ensuring the data is not corrupted.

Track a Secure Message

Track a secure message to ensure the message is delivered and opened.

Retract a Secure Message

Retract a secure message that was previously sent.

Parameters

Name Key Required Type Description
TransactionId
transactionId True uuid

The Id of the secure message to be retracted.

v
v True string

The version of the API. This can be found by visiting https://developers.datamotion.com and then select 'API versions (BaseURL)' from the left-hand menu.

X-API-Key
X-API-Key True string

A unique identifier used to identify the API Key object. To learn more about this, visit https://datamotion.com/how-to-use-datamotion-with-power-automate/.

X-API-Secret
X-API-Secret True string

A secret value tied to the API Key. To learn more about this, visit https://datamotion.com/how-to-use-datamotion-with-power-automate/.

Send a Secure Message

Sends a message in a secure manner ensuring the data is not corrupted.

Parameters

Name Key Required Type Description
From
From True string

The address of the user that will send the message.

To
To array of string

An array of recipients of the secure message.

Cc
Cc array of string

An array of recipients, carbon copied on the secure message.

Bcc
Bcc array of string

An array of recipients, blind carbon copied on the secure message.

Subject
Subject string

The subject of the secure message.

AttachmentBase64
AttachmentBase64 string

A Base64 encoded string of the attachment.

ContentType
ContentType string

The media type of the attachment.

FileName
FileName string

The name of the attachment file.

ContentId
ContentId string

The Content ID (only populated if the attachment is an inline image).

HtmlBody
HtmlBody string

The HTML body of the email message.

TextBody
TextBody string

The text body of the email message.

v
v True string

The version of the API. This can be found by visiting https://developers.datamotion.com and then select 'API versions (BaseURL)' from the left-hand menu.

X-API-Key
X-API-Key True string

A unique identifier used to identify the API Key object. To learn more about this, visit https://datamotion.com/how-to-use-datamotion-with-power-automate/.

X-API-Secret
X-API-Secret True string

A secret value tied to the API Key. To learn more about this, visit https://datamotion.com/how-to-use-datamotion-with-power-automate/.

Returns

Send secure message response model.

Track a Secure Message

Track a secure message to ensure the message is delivered and opened.

Parameters

Name Key Required Type Description
TransactionId
transactionId True uuid

The Id of the secure message to be tracked.

v
v True string

The version of the API. This can be found by visiting https://developers.datamotion.com and then select 'API versions (BaseURL)' from the left-hand menu.

X-API-Key
X-API-Key True string

A unique identifier used to identify the API Key object. To learn more about this, visit https://datamotion.com/how-to-use-datamotion-with-power-automate/.

X-API-Secret
X-API-Secret True string

A secret value tied to the API Key. To learn more about this, visit https://datamotion.com/how-to-use-datamotion-with-power-automate/.

Returns

Message tracking object.

Definitions

SendSecureMessageResponse

Send secure message response model.

Name Path Type Description
TransactionId
TransactionId uuid

The Id of the transaction.

NumberOfRecipients
NumberOfRecipients integer

The total number of recipients.

MessageSize
MessageSize integer

The size of the message in bytes.

Expiration
Expiration string

The date time in which the message expires.

ProjectId
ProjectId uuid

The Id of the project.

ApplicationId
ApplicationId uuid

The Id of the application

TrackMessageResponse

Message tracking object.

Name Path Type Description
Cost
Cost double

Total cost of the transaction.

Attachments
Attachments array of AttachmentMetaData

A complex type containing the Attachment Structure, the SecurityEnvelope Structure, and the Tracking Structure per attachment.

ExpirationDate
ExpirationDate string

The Date/time for message expiration.

MessageId
MessageId integer

The Id of the message.

MessageSize
MessageSize integer

The message size in bytes.

SecurityEnvelope
SecurityEnvelope object

The message security envelope object.

Tracking
Tracking array of Tracking

A list of message tracking objects.

Subject
Subject string

The message subject.

AttachmentMetaData

Message attachment object.

Name Path Type Description
AttachmentId
AttachmentId integer

Attachment unique identifier.

FileName
FileName string

Attachment file name.

ContentId
ContentId object

Attachment content Id (only populated if the attachment is an inline image).

ContentType
ContentType string

The media type of the attachment.

SecurityEnvelope
SecurityEnvelope object

Attachment security envelope.

Size
Size Size

Attachment size object.

Tracking
Tracking AttachmentTracking

Attachment tracking information.

Tracking

Message tracking information.

Name Path Type Description
DateOpened
DateOpened string

The date/time string of when the message was opened. Note: If year = 1900, then there is no DateOpened associated with the current message status.

Email
Email string

The email address of the recipient.

MessageStatusDescription
MessageStatusDescription string

Status represented as a string description.

MessageStatusId
MessageStatusId integer

Numeric indicator of the status of the individual recipient.

ReceiverField
ReceiverField string

Indicates whether this recipient was the TO, CC, or BCC of the message.

Size

Attachment size object.

Name Path Type Description
StdString
StdString string

A string value that contains the size of an attachment;

AttachmentTracking

Attachment tracking information.

Name Path Type Description
Recipients
Recipients array of Recipient

Message recipient object.

DateOpened
DateOpened string

The date/time string of when the message was opened. Note: If year = 1900, then there is no DateOpened associated with the current message status.

Email
Email string

The email address of the recipient.

MessageStatusDescription
MessageStatusDescription string

Status represented as a string description.

MessageStatusId
MessageStatusId integer

Numeric indicator of the status of the individual recipient.

ReceiverField
ReceiverField string

Indicates whether this recipient was the TO, CC, or BCC of the message.

Recipient

Message recipient object.

Name Path Type Description
ChecksumValidated
ChecksumValidated integer

One of the following values: 0 (Invalid), 1 (Valid), or 2 (NotApplied).

Delivered
Delivered boolean

Indicates whether or not the message has been delivered.

DeliveredDate
DeliveredDate string

The DateTime string representing when the message was delivered.

Downloaded
Downloaded boolean

Indicates whether or not the attachment has been downloaded.

DownloadedDate
DownloadedDate string

The DateTime string representing when the attachment was downloaded.

Email
Email string

The email address of the recipient.