Workiva Support Center

The Email connector enables you to include a Send Email command to send email as part of a chain. This command uses Simple Mail Transfer Protocol (SMTP) to send the email. Authentication can be done using either Basic authentication or OAuth2 authentication. The email can include additional context from earlier commands in the chain to enable enhanced automation.

SMTP prerequisites

To use the Email connector, your organization needs details about the SMTP server of its email provider, such as Gmail® or Microsoft® Office 365®.

To set up the connector, you'll need:

• The hostname of the SMTP server
• The port the SMTP server uses to send email
• The HELO domain, if required by the SMTP server
• If the SMTP server requires authentication, the username and password of the integration user the connector should authenticate as

OAuth2 prerequisites

Before you can use OAuth2 security for this connector, the following items must be present and implemented.

Azure elements

You must have:

• Both a Microsoft Azure account and an Azure account key.
• Set up an authorization code flow. in Azure.
• Configured the Exchange Online service in Azure.

• Set up the correct redirect URI in Azure when setting up the authorization code flow.

  Environment	Redirect URI
  APAC prod (Asia-Pacific region)	https://h.apac.wdesk.com/s/wdata/oc/app/oauth/callback
  CA prod (Canada)	https://h.ca.wdesk.com/s/wdata/oc/app/oauth/callback
  EU prod (EMEA)	https://h.eu.wdesk.com/s/wdata/oc/app/oauth/callback
  US prod (USA, Central America, South America)	https://h.app.wdesk.com/s/wdata/oc/app/oauth/callback

Refer to Microsoft Azure documentation for instructions on obtaining and implementing these prerequisites.

Workiva elements

• You must have enabled the Workiva Email connector (this requires an Organization Security Administrator).

Set up an Email connector

Note: To make the connector available for use in your organization's chains, an Organization Security Administrator must enable it from Configuration.

1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
2. Under Connector Connection, select Email and the default CloudRunner.
   
3. Enter a unique Name and Description to help identify the connection.

4. Under Properties, enter the connection's details:

   

   Property	Details
   Host name	Enter the SMTP server's host name: For Gmail, this is typically smtp.gmail.com For Microsoft 365, this is typically smtp.office365.com For Mailgun, this is typically smtp.mailgun.org
   Port	Enter the port the server runs on. The default SMTP port is typically 587, but it could also be 25.
   TLS enabled	If using a secure SMTP server that requires encrypted communication via Transport Layer, set the Security/Secure Sockets Layer (TLS/SSL) to Enabled.
   HELO domain	If required by the SMTP server, enter the HELO domain used to ensure a successful handshake.

   Note: All sensitive credentials are automatically encrypted and stored using Advanced Encryption Standard (AES)-256 encryption.

5. Under Authentication, select the authentication type you want to use and enter the information needed to authenticate the API calls. The information required will depend on the authentication type you select.

   For Basic Authentication

   

   Property	Details
   User name	If the SMTP server uses basic authentication, enter the username of the connector's integration user.
   Password	If the SMTP server requires basic authentication, enter the password associated with the username.

    

   For Microsoft Office 365 Email OAuth2

   

   Property	Details
   Username	This is the Username for accessing the SMTP server.
   Tenant ID	This is the ID string for your Microsoft tenant.
   Client ID	This is the Client ID for the key you want the API to use.
   Client Secret	This is the Client Secret for the key you want the API to use.

6. Click Connect.
7. Select the environments to use the connection, and click Save.
8. To test the connection, create and run a chain with the connector's Send Email command to send an email to your own email address, and verify it returns a valid output.

Troubleshooting

If the connector fails to send email:

• Verify that the hostname and port of your email provider's SMTP server are correct.
• Verify that the SMTP server domain type is correct (TLS or HELO).
• If using Basic authentication, verify that the username and password values are correct.
• If using OAuth2 authentication, verify that:
  • the ClientID and Client Secret values are correct.
  • the Redirect URI is correct in Azure when generating those Client ID and Client Secret values.
• Verify the recipient email addresses entered for the Send Email command's To, CC, and BCC inputs are correct.