Mailchimp synchronizer extension (#15512)

Challenge 10 from "Call for projects" list
This commit is contained in:
BOHEUS
2025-11-04 11:05:51 +00:00
committed by GitHub
parent e4dbe87fa1
commit ff1a87080a
7 changed files with 1558 additions and 0 deletions
File diff suppressed because one or more lines are too long
@@ -0,0 +1,3 @@
yarnPath: .yarn/releases/yarn-4.9.2.cjs
nodeLinker: node-modules
@@ -0,0 +1,25 @@
# Mailchimp synchronizer
Synchronizing contacts between Twenty and Mailchimp
## Requirements
- twenty-cli `npm install -g twenty-cli`
- an `apiKey`. Go to `https://twenty.com/settings/api-webhooks` to generate one
## Setup
1. Add app to your workspace
```bash
twenty auth login
cd mailchimp-synchronizer
twenty app sync
```
2. Go to Settings > Integrations > Mailchimp synchronizer > Settings and add required variables
## Flow
- Check if required variables are set, if not, exit
- Validate data based on set constraints
- If all constraints are checked, send a request to Mailchimp with new contact
## Note
- SMS support is experimental and may cause errors
@@ -0,0 +1,61 @@
{
"version": "0.0.1",
"license": "MIT",
"engines": {
"node": "^24.5.0",
"npm": "please-use-yarn",
"yarn": ">=4.0.2"
},
"packageManager": "yarn@4.9.2",
"$schema": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/appManifest.schema.json",
"universalIdentifier": "1eadac4e-db9f-4cce-b20b-de75f41e34dc",
"name": "Mailchimp synchronizer",
"description": "",
"env": {
"TWENTY_API_KEY": {
"isSecret": true,
"value": "",
"description": "Required to send requests to Twenty"
},
"TWENTY_API_URL": {
"value": "",
"description": "Optional, defaults to cloud API URL"
},
"MAILCHIMP_API_KEY": {
"isSecret": true,
"value": "",
"description": "Required to send requests to Mailchimp"
},
"MAILCHIMP_URL": {
"value": "",
"description": "Required to send requests to Mailchimp"
},
"IS_EMAIL_CONSTRAINT": {
"value": "false",
"description": "Set to true if you want to add additional constraint (default is false)"
},
"IS_PHONE_CONSTRAINT": {
"value": "false",
"description": "Set to true if you want to add additional constraint (default is false)"
},
"IS_COMPANY_CONSTRAINT": {
"value": "false",
"description": "Set to true if you want to add additional constraint (default is false)"
},
"IS_ADDRESS_CONSTRAINT": {
"value": "false",
"description": "Set to true if you want to add additional constraint (default is false)"
},
"UPDATE_PERSON": {
"value": "false",
"description": "Set to true if you want to update record if it exists"
},
"MAILCHIMP_AUDIENCE_ID": {
"value": "",
"description": "Required to send requests to Mailchimp"
}
},
"dependencies": {
"axios": "^1.13.1"
}
}
@@ -0,0 +1,12 @@
{
"$schema": "https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-cli/schemas/serverlessFunction.schema.json",
"universalIdentifier": "83319670-775b-4862-b133-5c353e594151",
"name": "mailchimp-synchronizer",
"triggers": [
{
"universalIdentifier": "e627ff6f-0a0c-48b2-bdbb-31967489ec96",
"type": "databaseEvent",
"eventName": "person.created"
}
]
}
@@ -0,0 +1,267 @@
import axios from 'axios';
const TWENTY_API_URL: string =
process.env.TWENTY_API_URL !== '' && process.env.TWENTY_API_URL !== undefined
? `${process.env.TWENTY_API_URL}/rest`
: 'https://api.twenty.com/rest';
const TWENTY_API_KEY: string = process.env.TWENTY_API_KEY ?? '';
const MAILCHIMP_API_URL: string =
process.env.MAILCHIMP_URL !== '' && process.env.MAILCHIMP_URL !== undefined
? `https://${process.env.MAILCHIMP_URL}.api.mailchimp.com/3.0/`
: '';
const MAILCHIMP_API_KEY: string = process.env.MAILCHIMP_API_KEY ?? '';
const MAILCHIMP_AUDIENCE_ID: string = process.env.MAILCHIMP_AUDIENCE_ID ?? '';
const IS_EMAIL_CONSTRAINT: boolean = process.env.IS_EMAIL_CONSTRAINT == 'true';
const IS_COMPANY_CONSTRAINT: boolean = process.env.COMPANY_CONSTRAINT == 'true';
const IS_PHONE_CONSTRAINT: boolean = process.env.IS_PHONE_CONSTRAINT == 'true';
const IS_ADDRESS_CONSTRAINT: boolean =
process.env.IS_ADDRESS_CONSTRAINT == 'true';
type mailchimpAddress = {
street1: string;
street2: string;
city: string;
state: string;
zipCode: string;
country: string;
};
type twentyAddress = {
addressStreet1: string;
addressStreet2: string;
addressCity: string;
addressState: string;
addressPostCode: string;
addressCountry: string;
};
type twentyPerson = {
name: {
firstName: string;
lastName: string;
};
email: {
primaryEmail: string;
};
phones: {
primaryPhoneNumber: string;
primaryPhoneCallingCode: string;
};
companyId: string;
};
const fetchCompanyData = async (companyId: string): Promise<object> => {
const options = {
method: 'GET',
headers: {
Authorization: `Bearer ${TWENTY_API_KEY}`,
},
url: `${TWENTY_API_URL}/company/${companyId}`,
};
try {
const temp = await axios.request(options);
return {
name: temp.data.name as string,
address: temp.data.address as twentyAddress,
};
} catch (error) {
if (axios.isAxiosError(error)) {
throw error;
}
throw error;
}
};
const checkAddress = (address: twentyAddress): mailchimpAddress => {
if (
address.addressStreet1 !== '' &&
address.addressCity !== '' &&
address.addressPostCode !== '' &&
address.addressState !== ''
) {
return {
street1: address.addressStreet1,
street2: address.addressStreet2,
city: address.addressCity,
state: address.addressState,
zipCode: address.addressPostCode,
country: address.addressCountry,
} as mailchimpAddress;
}
throw new Error('Invalid address');
};
const checkAudiencePermissions = async (
audienceId: string,
): Promise<string[]> => {
const options = {
method: 'GET',
headers: {
Authorization: `Bearer ${MAILCHIMP_API_KEY}`,
},
url: `${MAILCHIMP_API_URL}/audiences/${audienceId}`,
};
try {
const temp = await axios.request(options);
return temp.data.enabled_channels;
} catch (error) {
if (axios.isAxiosError(error)) {
throw error;
}
throw error;
}
};
const prepareData = (
firstName: string,
lastName: string,
email: string,
phoneNumber: string,
phoneCallingCode: string,
companyName: string,
address: mailchimpAddress,
): object => {
const data = {};
if (IS_EMAIL_CONSTRAINT) {
data['email_channel'] = {
email: email,
marketing_consent: {
status: 'unknown',
},
};
}
data['mergeFields'] = {
FNAME: firstName,
LNAME: lastName,
};
if (IS_ADDRESS_CONSTRAINT) {
data['mergeFields']['ADDRESS'] = address;
}
if (IS_PHONE_CONSTRAINT) {
const mergedPhoneNumber: string = phoneCallingCode.startsWith('+')
? phoneCallingCode.concat(phoneNumber)
: '+'.concat(phoneCallingCode, phoneNumber);
data['sms_channel'] = {
sms_phone: mergedPhoneNumber,
marketing_consent: {
status: 'unknown',
},
};
data['mergeFields']['PHONE'] = mergedPhoneNumber;
}
if (IS_COMPANY_CONSTRAINT) {
data['mergeFields']['COMPANY'] = companyName;
}
return data;
};
export const main = async (params: {
properties: Record<string, any>;
recordId: string;
userId: string;
}): Promise<object> => {
if (!IS_EMAIL_CONSTRAINT && !IS_PHONE_CONSTRAINT) {
console.log(
'Function exited as there are no constraints to email nor phone number',
);
return {};
}
if (
MAILCHIMP_API_URL === '' ||
MAILCHIMP_API_KEY === '' ||
MAILCHIMP_AUDIENCE_ID === ''
) {
console.log('Missing Mailchimp required parameters');
return {};
}
if (IS_COMPANY_CONSTRAINT && TWENTY_API_KEY === '') {
console.log('Missing Twenty related parameters');
return {};
}
try {
const { properties, recordId } = params;
console.log(properties);
console.log(recordId);
const twentyRecord: twentyPerson = properties as twentyPerson;
const email: boolean =
IS_EMAIL_CONSTRAINT && twentyRecord.email.primaryEmail !== '';
const phoneNumber: boolean =
IS_PHONE_CONSTRAINT &&
twentyRecord.phones.primaryPhoneNumber !== '' &&
twentyRecord.phones.primaryPhoneCallingCode !== '';
const company: object = IS_COMPANY_CONSTRAINT
? await fetchCompanyData(properties.after.companyId)
: null;
const companyName: string = company['name'] !== '' ? company['name'] : null;
const address: mailchimpAddress = IS_ADDRESS_CONSTRAINT
? checkAddress(company['address'])
: null;
if (
twentyRecord.name.firstName === '' ||
twentyRecord.name.lastName === ''
) {
console.error('First or last name is empty');
return {};
}
const audiencePermissions: string[] = await checkAudiencePermissions(
MAILCHIMP_AUDIENCE_ID,
);
if (
IS_EMAIL_CONSTRAINT &&
audiencePermissions.includes('Email') &&
!email
) {
console.error('Email is empty');
return {};
}
if (
IS_PHONE_CONSTRAINT &&
audiencePermissions.includes('SMS') &&
!phoneNumber
) {
console.error('Phone number is empty');
return {};
}
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${MAILCHIMP_API_KEY}`,
},
url: `${MAILCHIMP_API_URL}/audiences/${MAILCHIMP_AUDIENCE_ID}/contacts`,
data: prepareData(
twentyRecord.name.firstName,
twentyRecord.name.lastName,
twentyRecord.email.primaryEmail,
twentyRecord.phones.primaryPhoneNumber,
twentyRecord.phones.primaryPhoneCallingCode,
companyName,
address,
),
};
const temp = await axios.request(options);
if (temp.status === 200) {
console.log('Person has been successfully added');
return {};
} else {
throw temp;
}
} catch (error) {
if (axios.isAxiosError(error)) {
console.error(error.message);
return {};
}
console.error(error);
return {};
}
};
@@ -0,0 +1,248 @@
# This file is generated by running "yarn install" inside your project.
# Manual changes might be lost - proceed with caution!
__metadata:
version: 8
cacheKey: 10c0
"Mailchimp synchronizer@workspace:.":
version: 0.0.0-use.local
resolution: "Mailchimp synchronizer@workspace:."
dependencies:
axios: "npm:^1.13.1"
languageName: unknown
linkType: soft
"async-function@npm:^1.0.0":
version: 1.0.0
resolution: "async-function@npm:1.0.0"
checksum: 10c0/669a32c2cb7e45091330c680e92eaeb791bc1d4132d827591e499cd1f776ff5a873e77e5f92d0ce795a8d60f10761dec9ddfe7225a5de680f5d357f67b1aac73
languageName: node
linkType: hard
"async-generator-function@npm:^1.0.0":
version: 1.0.0
resolution: "async-generator-function@npm:1.0.0"
checksum: 10c0/2c50ef856c543ad500d8d8777d347e3c1ba623b93e99c9263ecc5f965c1b12d2a140e2ab6e43c3d0b85366110696f28114649411cbcd10b452a92a2318394186
languageName: node
linkType: hard
"asynckit@npm:^0.4.0":
version: 0.4.0
resolution: "asynckit@npm:0.4.0"
checksum: 10c0/d73e2ddf20c4eb9337e1b3df1a0f6159481050a5de457c55b14ea2e5cb6d90bb69e004c9af54737a5ee0917fcf2c9e25de67777bbe58261847846066ba75bc9d
languageName: node
linkType: hard
"axios@npm:^1.13.1":
version: 1.13.1
resolution: "axios@npm:1.13.1"
dependencies:
follow-redirects: "npm:^1.15.6"
form-data: "npm:^4.0.4"
proxy-from-env: "npm:^1.1.0"
checksum: 10c0/de9c3c6de43d3ee1146d3afe78645f19450cac6a5d7235bef8b8e8eeb705c2e47e2d231dea99cecaec4dae1897c521118ca9413b9d474063c719c4d94c5b9adc
languageName: node
linkType: hard
"call-bind-apply-helpers@npm:^1.0.1, call-bind-apply-helpers@npm:^1.0.2":
version: 1.0.2
resolution: "call-bind-apply-helpers@npm:1.0.2"
dependencies:
es-errors: "npm:^1.3.0"
function-bind: "npm:^1.1.2"
checksum: 10c0/47bd9901d57b857590431243fea704ff18078b16890a6b3e021e12d279bbf211d039155e27d7566b374d49ee1f8189344bac9833dec7a20cdec370506361c938
languageName: node
linkType: hard
"combined-stream@npm:^1.0.8":
version: 1.0.8
resolution: "combined-stream@npm:1.0.8"
dependencies:
delayed-stream: "npm:~1.0.0"
checksum: 10c0/0dbb829577e1b1e839fa82b40c07ffaf7de8a09b935cadd355a73652ae70a88b4320db322f6634a4ad93424292fa80973ac6480986247f1734a1137debf271d5
languageName: node
linkType: hard
"delayed-stream@npm:~1.0.0":
version: 1.0.0
resolution: "delayed-stream@npm:1.0.0"
checksum: 10c0/d758899da03392e6712f042bec80aa293bbe9e9ff1b2634baae6a360113e708b91326594c8a486d475c69d6259afb7efacdc3537bfcda1c6c648e390ce601b19
languageName: node
linkType: hard
"dunder-proto@npm:^1.0.1":
version: 1.0.1
resolution: "dunder-proto@npm:1.0.1"
dependencies:
call-bind-apply-helpers: "npm:^1.0.1"
es-errors: "npm:^1.3.0"
gopd: "npm:^1.2.0"
checksum: 10c0/199f2a0c1c16593ca0a145dbf76a962f8033ce3129f01284d48c45ed4e14fea9bbacd7b3610b6cdc33486cef20385ac054948fefc6272fcce645c09468f93031
languageName: node
linkType: hard
"es-define-property@npm:^1.0.1":
version: 1.0.1
resolution: "es-define-property@npm:1.0.1"
checksum: 10c0/3f54eb49c16c18707949ff25a1456728c883e81259f045003499efba399c08bad00deebf65cccde8c0e07908c1a225c9d472b7107e558f2a48e28d530e34527c
languageName: node
linkType: hard
"es-errors@npm:^1.3.0":
version: 1.3.0
resolution: "es-errors@npm:1.3.0"
checksum: 10c0/0a61325670072f98d8ae3b914edab3559b6caa980f08054a3b872052640d91da01d38df55df797fcc916389d77fc92b8d5906cf028f4db46d7e3003abecbca85
languageName: node
linkType: hard
"es-object-atoms@npm:^1.0.0, es-object-atoms@npm:^1.1.1":
version: 1.1.1
resolution: "es-object-atoms@npm:1.1.1"
dependencies:
es-errors: "npm:^1.3.0"
checksum: 10c0/65364812ca4daf48eb76e2a3b7a89b3f6a2e62a1c420766ce9f692665a29d94fe41fe88b65f24106f449859549711e4b40d9fb8002d862dfd7eb1c512d10be0c
languageName: node
linkType: hard
"es-set-tostringtag@npm:^2.1.0":
version: 2.1.0
resolution: "es-set-tostringtag@npm:2.1.0"
dependencies:
es-errors: "npm:^1.3.0"
get-intrinsic: "npm:^1.2.6"
has-tostringtag: "npm:^1.0.2"
hasown: "npm:^2.0.2"
checksum: 10c0/ef2ca9ce49afe3931cb32e35da4dcb6d86ab02592cfc2ce3e49ced199d9d0bb5085fc7e73e06312213765f5efa47cc1df553a6a5154584b21448e9fb8355b1af
languageName: node
linkType: hard
"follow-redirects@npm:^1.15.6":
version: 1.15.11
resolution: "follow-redirects@npm:1.15.11"
peerDependenciesMeta:
debug:
optional: true
checksum: 10c0/d301f430542520a54058d4aeeb453233c564aaccac835d29d15e050beb33f339ad67d9bddbce01739c5dc46a6716dbe3d9d0d5134b1ca203effa11a7ef092343
languageName: node
linkType: hard
"form-data@npm:^4.0.4":
version: 4.0.4
resolution: "form-data@npm:4.0.4"
dependencies:
asynckit: "npm:^0.4.0"
combined-stream: "npm:^1.0.8"
es-set-tostringtag: "npm:^2.1.0"
hasown: "npm:^2.0.2"
mime-types: "npm:^2.1.12"
checksum: 10c0/373525a9a034b9d57073e55eab79e501a714ffac02e7a9b01be1c820780652b16e4101819785e1e18f8d98f0aee866cc654d660a435c378e16a72f2e7cac9695
languageName: node
linkType: hard
"function-bind@npm:^1.1.2":
version: 1.1.2
resolution: "function-bind@npm:1.1.2"
checksum: 10c0/d8680ee1e5fcd4c197e4ac33b2b4dce03c71f4d91717292785703db200f5c21f977c568d28061226f9b5900cbcd2c84463646134fd5337e7925e0942bc3f46d5
languageName: node
linkType: hard
"generator-function@npm:^2.0.0":
version: 2.0.1
resolution: "generator-function@npm:2.0.1"
checksum: 10c0/8a9f59df0f01cfefafdb3b451b80555e5cf6d76487095db91ac461a0e682e4ff7a9dbce15f4ecec191e53586d59eece01949e05a4b4492879600bbbe8e28d6b8
languageName: node
linkType: hard
"get-intrinsic@npm:^1.2.6":
version: 1.3.1
resolution: "get-intrinsic@npm:1.3.1"
dependencies:
async-function: "npm:^1.0.0"
async-generator-function: "npm:^1.0.0"
call-bind-apply-helpers: "npm:^1.0.2"
es-define-property: "npm:^1.0.1"
es-errors: "npm:^1.3.0"
es-object-atoms: "npm:^1.1.1"
function-bind: "npm:^1.1.2"
generator-function: "npm:^2.0.0"
get-proto: "npm:^1.0.1"
gopd: "npm:^1.2.0"
has-symbols: "npm:^1.1.0"
hasown: "npm:^2.0.2"
math-intrinsics: "npm:^1.1.0"
checksum: 10c0/9f4ab0cf7efe0fd2c8185f52e6f637e708f3a112610c88869f8f041bb9ecc2ce44bf285dfdbdc6f4f7c277a5b88d8e94a432374d97cca22f3de7fc63795deb5d
languageName: node
linkType: hard
"get-proto@npm:^1.0.1":
version: 1.0.1
resolution: "get-proto@npm:1.0.1"
dependencies:
dunder-proto: "npm:^1.0.1"
es-object-atoms: "npm:^1.0.0"
checksum: 10c0/9224acb44603c5526955e83510b9da41baf6ae73f7398875fba50edc5e944223a89c4a72b070fcd78beb5f7bdda58ecb6294adc28f7acfc0da05f76a2399643c
languageName: node
linkType: hard
"gopd@npm:^1.2.0":
version: 1.2.0
resolution: "gopd@npm:1.2.0"
checksum: 10c0/50fff1e04ba2b7737c097358534eacadad1e68d24cccee3272e04e007bed008e68d2614f3987788428fd192a5ae3889d08fb2331417e4fc4a9ab366b2043cead
languageName: node
linkType: hard
"has-symbols@npm:^1.0.3, has-symbols@npm:^1.1.0":
version: 1.1.0
resolution: "has-symbols@npm:1.1.0"
checksum: 10c0/dde0a734b17ae51e84b10986e651c664379018d10b91b6b0e9b293eddb32f0f069688c841fb40f19e9611546130153e0a2a48fd7f512891fb000ddfa36f5a20e
languageName: node
linkType: hard
"has-tostringtag@npm:^1.0.2":
version: 1.0.2
resolution: "has-tostringtag@npm:1.0.2"
dependencies:
has-symbols: "npm:^1.0.3"
checksum: 10c0/a8b166462192bafe3d9b6e420a1d581d93dd867adb61be223a17a8d6dad147aa77a8be32c961bb2f27b3ef893cae8d36f564ab651f5e9b7938ae86f74027c48c
languageName: node
linkType: hard
"hasown@npm:^2.0.2":
version: 2.0.2
resolution: "hasown@npm:2.0.2"
dependencies:
function-bind: "npm:^1.1.2"
checksum: 10c0/3769d434703b8ac66b209a4cca0737519925bbdb61dd887f93a16372b14694c63ff4e797686d87c90f08168e81082248b9b028bad60d4da9e0d1148766f56eb9
languageName: node
linkType: hard
"math-intrinsics@npm:^1.1.0":
version: 1.1.0
resolution: "math-intrinsics@npm:1.1.0"
checksum: 10c0/7579ff94e899e2f76ab64491d76cf606274c874d8f2af4a442c016bd85688927fcfca157ba6bf74b08e9439dc010b248ce05b96cc7c126a354c3bae7fcb48b7f
languageName: node
linkType: hard
"mime-db@npm:1.52.0":
version: 1.52.0
resolution: "mime-db@npm:1.52.0"
checksum: 10c0/0557a01deebf45ac5f5777fe7740b2a5c309c6d62d40ceab4e23da9f821899ce7a900b7ac8157d4548ddbb7beffe9abc621250e6d182b0397ec7f10c7b91a5aa
languageName: node
linkType: hard
"mime-types@npm:^2.1.12":
version: 2.1.35
resolution: "mime-types@npm:2.1.35"
dependencies:
mime-db: "npm:1.52.0"
checksum: 10c0/82fb07ec56d8ff1fc999a84f2f217aa46cb6ed1033fefaabd5785b9a974ed225c90dc72fff460259e66b95b73648596dbcc50d51ed69cdf464af2d237d3149b2
languageName: node
linkType: hard
"proxy-from-env@npm:^1.1.0":
version: 1.1.0
resolution: "proxy-from-env@npm:1.1.0"
checksum: 10c0/fe7dd8b1bdbbbea18d1459107729c3e4a2243ca870d26d34c2c1bcd3e4425b7bcc5112362df2d93cc7fb9746f6142b5e272fd1cc5c86ddf8580175186f6ad42b
languageName: node
linkType: hard