Docs
Tutorials
Developer Program
Your apps

Create an email campaign

Connector functions are a new addition to Slack automations. We recommend understanding the systems and APIs you're integrating with before setup.

Facts

Create an email campaign

Schema: Connectors.Mailchimp.functions.CreateCampaign
Service: Mailchimp

Input parameters

Required parameters
mailchimp_access_token
slack#/types/credential/oauth2
·Required
Determines whether this connector will use the credentials of the user starting the workflow or the credentials configured by an app collaborator. See the Authentication section on this page for details.

Example
{ credential_source: "END_USER" }
campaign_title
string
·Required
The title of this campaign

Example
"Developer newsletter"
subject_line
string
·Required
The subject line for the campaign

Example
"Developer's Monthly Newsletter"
preview_text
string
·Required
The preview text for the campaign

Example
"We've released another version of our developer tools."
from_name
string
·Required
The 'from' name on a campaign (not an email address)

Example
"Developer Marketing"
reply_to
string
·Required
The reply-to email address for the campaign.

Example
"replies@devrel.salesforce.tld"
audience_id
string
·Required
The ID of the audience to associate with this campaign

Example
"1234567890"
Optional parameters

Output parameters

Required parameters
id
string
·Required
status
string
·Required
url
string
·Required

Authentication

A connector's access token property specifies how the connector handles authentication.

This connector only supports using the credentials of the user running the workflow, so the credential_source of this connector's access token parameter must be set to "END_USER".

End-user authentication

user Workflows that include a connector function relying on end-user authentication can can only be started with a link trigger.

mailchimp_access_token: {
    credential_source: "END_USER"
}

End-user experience: User will be prompted to link their external account via OAuth when they first start the workflow that contains this connector.

Developer experience: Developer does not have to implement authentication in app.

How to use

First, import Connectors from deno-slack-hub into your project's import_map.json file, like this:

{
  "imports": {
    "deno-slack-hub/": "https://deno.land/x/deno_slack_hub@2.2.0/",
    "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.14.2/",
    "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/",
  }
}

Next, import Connectors at the top of your workflow's definition file:

// my_workflow_file.ts
import { Connectors } from "deno-slack-hub/mod.ts";

Finally, add the connector as a step in your workflow just like you would a built-in Slack function.

SomeWorkflow.addStep(
  Connectors.Mailchimp.functions.CreateCampaign, {
  //...

🧙🏼 Your admin may need to approve the connector first. If your workspace has been configured to only allow admin-approved apps, the CLI will prompt you to send an admin approval request the first time you try to use a connector that hasn't been approved by an admin yet. While waiting for admin approval, the CLI may report an error like this:

Workflow function... is referring to an unknown step output parameter...

You can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.