:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { FetchResponse } from '~/common/utils/request'
import { ProcessedPluginEvent, RetryError } from '~/plugin-scaffold'
import { LegacyDestinationPluginMeta } from '../../types'
const hubspotPropsMap = {
companyName: 'company',
company_name: 'company',
company: 'company',
lastName: 'lastname',
last_name: 'lastname',
lastname: 'lastname',
firstName: 'firstname',
first_name: 'firstname',
firstname: 'firstname',
phone_number: 'phone',
phoneNumber: 'phone',
phone: 'phone',
website: 'website',
domain: 'website',
company_website: 'website',
companyWebsite: 'website',
}
export async function setupPlugin({ config, global, fetch: request }: LegacyDestinationPluginMeta) {
try {
global.hubspotAccessToken = config.hubspotAccessToken
const authResponse = await request(
`https://api.hubapi.com/crm/v3/objects/contacts?limit=1&paginateAssociations=false&archived=false`,
{
headers: {
Authorization: `Bearer ${config.hubspotAccessToken}`,
'Content-Type': 'application/json',
},
}
)
if (!statusOk(authResponse)) {
throw new Error('Unable to connect to Hubspot. Please make sure your API key is correct.')
}
} catch (error) {
throw new RetryError(error)
}
}
export async function onEvent(event: ProcessedPluginEvent, meta: LegacyDestinationPluginMeta) {
const { config, global } = meta
const triggeringEvents = (config.triggeringEvents || '').split(',')
if (triggeringEvents.indexOf(event.event) >= 0) {
const email = getEmailFromEvent(event)
if (email) {
const emailDomainsToIgnore = (config.ignoredEmails || '').split(',')
if (emailDomainsToIgnore.indexOf(email.split('@')[1]) >= 0) {
return
}
await createHubspotContact(
meta,
email,
{
...(event['$set'] ?? {}),
...(event['properties'] ?? {}),
},
global.hubspotAccessToken,
config.additionalPropertyMappings,
event['timestamp']
)
}
}
}
async function createHubspotContact(
meta: LegacyDestinationPluginMeta,
email: string,
properties: Record<string, any>,
accessToken: string,
additionalPropertyMappings: string,
eventSendTime: string
) {
const hubspotFilteredProps: Record<string, any> = {}
for (const [key, val] of Object.entries(properties)) {
if (key in hubspotPropsMap) {
hubspotFilteredProps[hubspotPropsMap[key as keyof typeof hubspotPropsMap]] = val
}
}
if (additionalPropertyMappings) {
for (const mapping of additionalPropertyMappings.split(',')) {
const [postHogProperty, hubSpotProperty] = mapping.split(':')
if (postHogProperty && hubSpotProperty) {
// special case to convert an event's timestamp to the format Hubspot uses them
if (postHogProperty === 'sent_at' || postHogProperty === 'created_at') {
const d = new Date(eventSendTime)
d.setUTCHours(0, 0, 0, 0)
hubspotFilteredProps[hubSpotProperty] = d.getTime()
} else if (postHogProperty in properties) {
hubspotFilteredProps[hubSpotProperty] = properties[postHogProperty]
}
}
}
}
const addContactResponse = await meta.fetch(`https://api.hubapi.com/crm/v3/objects/contacts`, {
method: 'POST',
headers: {
Authorization: `Bearer ${accessToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ properties: { email: email, ...hubspotFilteredProps } }),
})
const addContactResponseJson = await addContactResponse.json()
if (!statusOk(addContactResponse) || addContactResponseJson.status === 'error') {
const errorMessage = addContactResponseJson.message ?? ''
meta.logger.log(
`Unable to add contact ${email} to Hubspot. Status Code: ${addContactResponse.status}. Error message: ${errorMessage}`
)
if (addContactResponse.status === 409) {
const existingIdRegex = /Existing ID: ([0-9]+)/
const existingId = addContactResponseJson.message.match(existingIdRegex)
meta.logger.log(`Attempting to update contact ${email} instead...`)
const updateContactResponse = await meta.fetch(
`https://api.hubapi.com/crm/v3/objects/contacts/${existingId[1]}`,
{
method: 'PATCH',
headers: {
Authorization: `Bearer ${accessToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ properties: { email: email, ...hubspotFilteredProps } }),
}
)
const updateResponseJson = await updateContactResponse.json()
if (!statusOk(updateContactResponse)) {
const errorMessage = updateResponseJson.message ?? ''
meta.logger.log(
`Unable to update contact ${email} to Hubspot. Status Code: ${updateContactResponse.status}. Error message: ${errorMessage}`
)
} else {
meta.logger.log(`Successfully updated Hubspot Contact for ${email}`)
}
}
} else {
meta.logger.log(`Created Hubspot Contact for ${email}`)
}
}
function statusOk(res: FetchResponse): boolean {
return String(res.status)[0] === '2'
}
function isEmail(email: string): boolean {
const re =
/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/
return re.test(String(email).toLowerCase())
}
function getEmailFromEvent(event: ProcessedPluginEvent): string | null {
if (isEmail(event.distinct_id)) {
return event.distinct_id
} else if (event['$set'] && Object.keys(event['$set']).includes('email')) {
if (isEmail(event['$set']['email'])) {
return event['$set']['email']
}
} else if (event['properties'] && Object.keys(event['properties']).includes('email')) {
if (isEmail(event['properties']['email'])) {
return event['properties']['email']
}
}
return null
}