Manage the govDelivery Connector

This is an admin task 

The Forms & Workflow Communications (govDelivery) Connector lets you capture subscribers in your Communications account via your forms.

Using the Subscriber capture field, form authors can choose which subscriber topics to display and respondents are able to select which topics they want to subscribe to.

You can connect multiple Communications accounts. For example, you can create one for staging and another for a production environment. Your organization may also own several Communications accounts so you can create a separate connector for each.

Before You Begin

To connect, you will need to work with your Communications administrator to obtain:

• A Communications environment configured for your organization, including the relevant topics you want to display
• Communications API endpoint base URL
• Communications account code
• Communications administrator credentials (username and password). Please note that this administrator must have the Web Services Account Administrator role to perform tasks via API.

For best results, ensure your Communications administrator has the relevant topics and categories configured in your organization's account ready to receive subscribers. 

Set Up the Communications Connector 

Once you are ready to connect:

1. Go to Integrations > Connectors and select Communications under Form add-ons.
   
   
2. Select Add to connect to a new Communications account.
   
3. Enter the following details and select Add.
   • Name: A unique name for the connection
   • Communications API endpoint base URL: The base URL for your Communications environment.
   • Account code: The Code from your organization's Communications Account Settings.
   • Username: The username for a Communications user with the Web Services Account Administrator role.
   • Password: The password for a Communications user with the Web Services Account Administrator role.
4. Once added, the connection is listed in the Active connections. Select the connection to edit it and select See all to see a searchable list of forms using the connection.
   

With the connection in place, form authors can start adding the Subscriber capture field to their forms.

Subscriber Capture Field Settings

Form authors can add the Subscriber capture field to any form and choose which Communications connection to use and which topics to display to respondents. You'll find the Subscriber capture field in the Advanced section of the form builder.

These field settings are accessed via the gear icon:

• Required field?: Check this box to make this field mandatory for respondents to complete before submitting the form.
• Description: Add a description for the field. This will appear below the field title.
• Communications connection: Choose which Communications connection to use on this form. This will influence which Subscriber topics are available for authors to display; the Subscriber topics will populate once you select a connection.
• Data privacy policy URL: Enter the URL to your organization's privacy policy, which will be linked in the form. Respondents will need to consent to this policy before they can submit and subscribe on your form.
• Subscriber topics: Check each topic or category you want to include in your form. These topics are created in Communications and accessed via the Communications connection you choose. Each topic you check will be presented to form respondents as they subscribe. Select all to check all topics and Clear all to uncheck all topics.

Using Subscriber Capture

Select Save and preview to see how respondents can subscribe to Communications topics.

1. As they fill out the form, respondents will see a radio button question that represents your Subscriber capture field and the list of Subscriber topics you selected. By default, the Subscriber capture field is not a required field, so respondents can move through the form without select Yes or No.
   
   
2. Selecting Yes will allow them to provide an email address and check the topics they want to subscribe to. If your form has an Email field, the address provided will be piped into the Subscriber capture.
   
3. Respondents are required to check the box consenting to your privacy policy before continuing or submitting. The Data privacy policy URL you provided will be linked here.
4. Selecting No will remove the topics display and allow them to continue or submit the form.
   

You can manage subscribers, topics, messages, and reports from your Communications account.