Skip to content

feat(integration): add Pinterest click ID capture (epik/_epik) #1126

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
jciafardone wants to merge 8 commits into
base: development
Choose a base branch
from
Open

feat(integration): add Pinterest click ID capture (epik/_epik) #1126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f0d118a
Update integrationCapture.ts to include Pinterest
jciafardone Dec 6, 2025
20e5c56
test: add Pinterest _epik click ID tests
jciafardone Dec 9, 2025
6b060f0
test: add Pinterest _epik tests for cookies and localStorage
jciafardone Dec 9, 2025
e11cf61
Update src/integrationCapture.ts
jciafardone Dec 17, 2025
2dfa771
feat: add support for Pinterest epik parameter (without underscore)
jciafardone Dec 17, 2025
0097412
Merge branch 'development' into patch-1
jciafardone Jan 13, 2026
fd32377
Update integrationCapture.ts
jciafardone Jan 13, 2026
6f8b9f5
Update integrationCapture.ts
jciafardone Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/integrationCapture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,17 @@ const integrationMappingExternal: IntegrationIdMapping = {
mappedKey: 'SnapchatConversions.ClickId',
output: IntegrationOutputs.CUSTOM_FLAGS,
},

// Pinterest
// https://developers.pinterest.com/docs/track-conversions/track-conversions-in-the-api/
// https://help.pinterest.com/en/business/article/pinterest-tag-parameters-and-cookies
epik: {
mappedKey: 'Pinterest.click_id',
output: IntegrationOutputs.CUSTOM_FLAGS,
},
_epik: {
mappedKey: 'Pinterest.click_id',
output: IntegrationOutputs.CUSTOM_FLAGS,
// Snapchat
// https://developers.snap.com/api/marketing-api/Conversions-API/UsingTheAPI#sending-click-id
_scid: {
Expand Down
111 changes: 111 additions & 0 deletions test/jest/integration-capture.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ describe('Integration Capture', () => {
'wbraid',
'ttclid',
'ScCid',
'epik',
'_epik'
'_scid'
]);
});
Expand Down Expand Up @@ -313,6 +315,98 @@ describe('Integration Capture', () => {
});
});

describe('Pinterest Click Ids', () => {
it('should capture Pinterest specific click ids from query params (_epik)', () => {
const url = new URL('https://www.example.com/?_epik=1234');

window.location.href = url.href;
window.location.search = url.search;

const integrationCapture = new IntegrationCapture('all');
integrationCapture.capture();

expect(integrationCapture.clickIds).toEqual({
_epik: '1234',
});
});

it('should capture Pinterest specific click ids from query params (epik)', () => {
const url = new URL('https://www.example.com/?epik=5678');

window.location.href = url.href;
window.location.search = url.search;

const integrationCapture = new IntegrationCapture('all');
integrationCapture.capture();

expect(integrationCapture.clickIds).toEqual({
epik: '5678',
});
});

it('should capture Pinterest specific click ids from cookies (_epik)', () => {
const url = new URL('https://www.example.com/');

window.document.cookie = '_epik=pinterest_cookie_value';
window.location.href = url.href;
window.location.search = url.search;

const integrationCapture = new IntegrationCapture('all');
integrationCapture.capture();

expect(integrationCapture.clickIds).toEqual({
_epik: 'pinterest_cookie_value',
});
});

it('should capture Pinterest specific click ids from cookies (epik)', () => {
const url = new URL('https://www.example.com/');

window.document.cookie = 'epik=pinterest_cookie_value_epik';
window.location.href = url.href;
window.location.search = url.search;

const integrationCapture = new IntegrationCapture('all');
integrationCapture.capture();

expect(integrationCapture.clickIds).toEqual({
epik: 'pinterest_cookie_value_epik',
});
});

it('should capture Pinterest specific click ids from localStorage (_epik)', () => {
const url = new URL('https://www.example.com/');

window.location.href = url.href;
window.location.search = url.search;

localStorage.setItem('_epik', 'pinterest_localstorage_value');

const integrationCapture = new IntegrationCapture('all');
integrationCapture.capture();

expect(integrationCapture.clickIds).toEqual({
_epik: 'pinterest_localstorage_value',
});
});

it('should capture Pinterest specific click ids from localStorage (epik)', () => {
const url = new URL('https://www.example.com/');

window.location.href = url.href;
window.location.search = url.search;

localStorage.setItem('epik', 'pinterest_localstorage_value_epik');

const integrationCapture = new IntegrationCapture('all');
integrationCapture.capture();

expect(integrationCapture.clickIds).toEqual({
epik: 'pinterest_localstorage_value_epik',
});
});
});

describe('Facebook Click Ids', () => {
it('should format fbclid correctly', () => {
jest.spyOn(Date, 'now').mockImplementation(() => 42);
Expand Down Expand Up @@ -716,6 +810,7 @@ describe('Integration Capture', () => {
_ttp: '0823422223.23234',
ttclid: '12345',
gclid: '123233.23131',
epik: 'pinterest123',
ScCid: '456789',
_scid: 'cookie1-value',
invalidId: '12345',
Expand All @@ -728,10 +823,26 @@ describe('Integration Capture', () => {
'Facebook.BrowserId': '54321',
'TikTok.Callback': '12345',
'GoogleEnhancedConversions.Gclid': '123233.23131',
'Pinterest.click_id': 'pinterest123',
'SnapchatConversions.ClickId': '456789',
'SnapchatConversions.Cookie1': 'cookie1-value',
});
});

it('should map both epik and _epik to Pinterest.click_id', () => {
const integrationCapture = new IntegrationCapture('all');
integrationCapture.clickIds = {
epik: 'pinterest_epik',
_epik: 'pinterest_underscore_epik',
};

const customFlags = integrationCapture.getClickIdsAsCustomFlags();

// Both map to the same key, last one wins (based on object iteration order)
expect(customFlags).toHaveProperty('Pinterest.click_id');
// The value will be one of them depending on iteration order
expect(['pinterest_epik', 'pinterest_underscore_epik']).toContain(customFlags['Pinterest.click_id']);
});
});

describe('#getClickIdsAsPartnerIdentites', () => {
Expand Down