Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃幆 New Sink Connector Request: Mail-chimp #254

Open
Michaelg22 opened this issue Mar 8, 2023 · 1 comment
Open

馃幆 New Sink Connector Request: Mail-chimp #254

Michaelg22 opened this issue Mar 8, 2023 · 1 comment
Assignees
Labels

Comments

@Michaelg22
Copy link
Contributor

Michaelg22 commented Mar 8, 2023

Sink Connector-Mail-chimp

What is a Vanus Connector

Vanus Connect allows you to skip the complex integration with external services by offering out-of-the-box connectors. Each connector acts as a proxy between outside services and your system, enabling users to have faster integrations with no codes. All data produced or processed by our connectors conforms to the CloudEvents specification, which helps enterprises leverage event-driven architecture to do business in the age of events.

What is a Sink Connector

A sink connector receives CloudEvents and does some specific business logics. For example:

  • MySQL Sink extracts useful data from CloudEvents and writes them to a MySQL database.
  • Display Sink prints incoming CloudEvents out.
  • Slack Sink extracts data from CloudEvents and send them to a Slack channel.

CloudEvent

{
"specversion": "1.0",
"id": "53d1c340-551a-11ed-96c7-8b504d95037c",
"source": "source-connector",
"type": "create-campaign",
"datacontenttype": "application/json",
"time": "2022-10-26T10:38:29.345Z",
"data": {
...
}
}

Each action will be according to the event field type:

"type": "create-campaign",
or
"type": "create-tag",
or
"type": "add-update-subscription",
or
"type": "delete-subscription",
or
"type": "remove-subscriber-tag",
or
"type": "send-campaign",
or
"type": "add-subscriber-tag",

Features of this Connector

  • Allow users to Create a new campaign:

You can create a new campaign using the Mailchimp API. This includes specifying the campaign type (regular, automated, plain-text, A/B testing, etc.), the list or segment to which the campaign will be sent, and the content of the campaign.

  • Allow users to Create tags:

Tags are a way to categorize and organize your subscribers within your mailing list.

  • Allow users to Add or update subscribers:

With Mailchimp's API, you can add or update subscribers to your mailing list. This includes specifying the email address, name, and any additional fields you've created in your list. You can also update existing subscriber data, such as their name, email address, or list membership.

  • Delete subscribers:

You can use the Mailchimp API to delete subscribers from your list.

  • Remove subscriber from tags:

Tags are a way to categorize and organize your subscribers within your mailing list.

  • Send to an existing campaign:

This will send an email to all subscribers of that campaign.

  • Add subscriber to tag

add an email address to a tag.]

How to create a new connector

  1. Fork the vanus-connect repo.
  2. Create a sink_Mail_chimp_proposal.md based on the sink_proposal_example.md under vanus-connect/proposals directory. The proposal will introduce how a developer tends to implement the connector in detail. The proposal PR must be approved and merged before going to the next step.
  3. Copy one of the sink templates (Golang template, Java template) to vanus-connect/connectors/ and rename it as sink-Mail-chimps.
  4. Implement your connector and submit a PR.
  5. Wait the connector to be reviewed and approved.

How to claim to implement this connector

f you want to solve this issue, please leave a comment in this issue like:

I'd like to implement the connector, please assign it to me.

Vanus community will assign the issue to you on time.

@soumyadeep589
Copy link
Contributor

I'd like to implement the connector, please assign it to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants