MailChimp policy

A MailChimp policy contains the connection details that are used by a MailChimp Input or MailChimp Request node when connecting to MailChimp.

You can use a MailChimp Request node in a message flow to connect IBM® App Connect Enterprise to MailChimp and issue requests to create, retrieve, or delete objects such as campaigns, campaign folders, campaign reports, files, folders, and interests. You can use a MailChimp Input node in a message flow to monitor and accept input from MailChimp. The MailChimp policy controls, at run time, access to the MailChimp account.

The MailChimp policy is created when you configure a connection between a MailChimp Request or MailChimp Input node and MailChimp by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in the MailChimp policy. The policy is created with a type of MailChimp, and the name of the policy is returned to the node and specified in the Connection tab, in the format {policyProjectName}:policyName.

You can also create, update, or delete a MailChimp policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy a MailChimp policy, all message flows that are using the policy are stopped and restarted.

For more information about using MailChimp policies, see Using MailChimp with IBM App Connect Enterprise.

Table 1. Properties of the MailChimp policy
Property Property name in .policyxml file Description of properties
MailChimp Application Type applicationType This property is reserved for future use and must be set to the value online.
MailChimp Application Version applicationVersion This property is reserved for future use and must be set to the value v1.
MailChimp Authentication method authenticationMethod This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and MailChimp. This value is reserved for future use and must be set to BASIC_OAUTH.
Credential Name credentialName This property specifies the name of the credential that is used for the connection to MailChimp.

The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.