{"_id":"@cataline/facebook-conversion-api","_rev":"4-3e2cdb0670843eaa03ffd48cbf32f9a6","name":"@cataline/facebook-conversion-api","description":"> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)","dist-tags":{"latest":"0.4.1"},"versions":{"0.1.0":{"name":"@cataline/facebook-conversion-api","version":"0.1.0","keywords":["facebook","conversion","api"],"author":{"name":"Cataline"},"license":"MIT","_id":"@cataline/facebook-conversion-api@0.1.0","homepage":"https://github.com/cataline/facebook-conversion-api#readme","bugs":{"url":"https://github.com/cataline/facebook-conversion-api/issues"},"dist":{"shasum":"0ed1b9e236e5da96e9c218a0ea2ee54e693af742","tarball":"https://registry.npmjs.org/@cataline/facebook-conversion-api/-/facebook-conversion-api-0.1.0.tgz","fileCount":8,"integrity":"sha512-f6bzifbROtRhGNhNWInspkkddLIaaQ9Ox5xBmSXFKtF3GEJt1F+zzfImDaivikFqURF9oyYXXsNu908aMiLc+Q==","signatures":[{"sig":"MEQCIG9+1+S50OGnZdgxz1GTYssFzI6hqShaEttycy5gXAqNAiB2HaYn4ETQrsKow/mWvgAgf9fn2FI2LqpJ48XLawNdfQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":267424},"main":"./dist/facebook-conversion-api.umd.cjs","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/facebook-conversion-api.js","require":"./dist/facebook-conversion-api.umd.cjs"}},"gitHead":"967ab75b2b62f8af28b23f8a5aed0115585416e8","scripts":{"dev":"vite","build":"tsc && vite build","preview":"vite preview"},"_npmUser":{"name":"yungsilva","email":"yungsilva974@gmail.com"},"repository":{"url":"git+https://github.com/cataline/facebook-conversion-api.git","type":"git"},"_npmVersion":"10.2.4","description":"> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)","directories":{},"_nodeVersion":"20.11.0","dependencies":{"ofetch":"^1.3.4","crypto-js":"^4.2.0"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.3.1","typescript":"^5.2.2","@types/node":"^20.14.9","vite-plugin-dts":"^3.9.1","@types/crypto-js":"^4.2.2"},"_npmOperationalInternal":{"tmp":"tmp/facebook-conversion-api_0.1.0_1719776491439_0.09113009657315918","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"@cataline/facebook-conversion-api","version":"0.2.0","keywords":["facebook","conversion","api"],"author":{"name":"Cataline"},"license":"MIT","_id":"@cataline/facebook-conversion-api@0.2.0","maintainers":[{"name":"yungsilva","email":"yungsilva974@gmail.com"}],"homepage":"https://github.com/cataline/facebook-conversion-api#readme","bugs":{"url":"https://github.com/cataline/facebook-conversion-api/issues"},"dist":{"shasum":"420a891097215d73db9f1d45cbf8e149df5a240c","tarball":"https://registry.npmjs.org/@cataline/facebook-conversion-api/-/facebook-conversion-api-0.2.0.tgz","fileCount":8,"integrity":"sha512-79vTCC3mk4VUM9FGnKgktB0AO0/hrMyMPH9ACUi+OxSd71mteDXHxictnEIPsjQl5N02VnsJhq08jSmt5NnWxQ==","signatures":[{"sig":"MEUCIADd4/oFUhF0YEq3hHGzn/n5jjv4nP/kxUBJWy21xm46AiEAk90Qk8dYTp12oKD9KFlmBtI+RECTHEvolOW+PIWHMr0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":268898},"main":"./dist/facebook-conversion-api.umd.cjs","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/facebook-conversion-api.js","require":"./dist/facebook-conversion-api.umd.cjs"}},"gitHead":"7b49f94a63ca30fed8460910d5c14ae4c64cc8dd","scripts":{"dev":"vite","build":"tsc && vite build","preview":"vite preview"},"_npmUser":{"name":"yungsilva","email":"yungsilva974@gmail.com"},"repository":{"url":"git+https://github.com/cataline/facebook-conversion-api.git","type":"git"},"_npmVersion":"10.2.4","description":"> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)","directories":{},"_nodeVersion":"20.11.0","dependencies":{"ofetch":"^1.3.4","crypto-js":"^4.2.0"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.3.1","typescript":"^5.2.2","@types/node":"^20.14.9","vite-plugin-dts":"^3.9.1","@types/crypto-js":"^4.2.2"},"_npmOperationalInternal":{"tmp":"tmp/facebook-conversion-api_0.2.0_1720202277675_0.8133946742245626","host":"s3://npm-registry-packages"}},"0.3.0":{"name":"@cataline/facebook-conversion-api","version":"0.3.0","keywords":["facebook","conversion","api"],"author":{"name":"Cataline"},"license":"MIT","_id":"@cataline/facebook-conversion-api@0.3.0","maintainers":[{"name":"yungsilva","email":"yungsilva974@gmail.com"}],"homepage":"https://github.com/cataline/facebook-conversion-api#readme","bugs":{"url":"https://github.com/cataline/facebook-conversion-api/issues"},"dist":{"shasum":"08fbb8a0c1bad7dcc2f720c428365e30c87b9f7d","tarball":"https://registry.npmjs.org/@cataline/facebook-conversion-api/-/facebook-conversion-api-0.3.0.tgz","fileCount":8,"integrity":"sha512-E3rGZc6OuSxY6jPixF1DKnnYJNBFs4omDwXjfaEaBqhQIE9djl7R26qyd55WR4cgz3LnbhqFsQdQdsGyAlQqhw==","signatures":[{"sig":"MEUCIH8PEmUuzqlCZwv52gNtlEdb0Yk/U6rBken8fBMy+kFIAiEA0hN4e82tPyP4cyDt9rwaKtPsbeaAElKOjetJIKMCZjI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":268909},"main":"./dist/facebook-conversion-api.umd.cjs","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/facebook-conversion-api.js","require":"./dist/facebook-conversion-api.umd.cjs"}},"gitHead":"70443803a5e9499d3c3035c1b628e99d4681f45c","scripts":{"dev":"vite","build":"tsc && vite build","preview":"vite preview"},"_npmUser":{"name":"yungsilva","email":"yungsilva974@gmail.com"},"repository":{"url":"git+https://github.com/cataline/facebook-conversion-api.git","type":"git"},"_npmVersion":"10.2.4","description":"> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)","directories":{},"_nodeVersion":"20.11.0","dependencies":{"ofetch":"^1.3.4","crypto-js":"^4.2.0"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.3.1","typescript":"^5.2.2","@types/node":"^20.14.9","vite-plugin-dts":"^3.9.1","@types/crypto-js":"^4.2.2"},"_npmOperationalInternal":{"tmp":"tmp/facebook-conversion-api_0.3.0_1720212635528_0.35703032722560146","host":"s3://npm-registry-packages"}},"0.4.0":{"name":"@cataline/facebook-conversion-api","version":"0.4.0","keywords":["facebook","conversion","api"],"author":{"name":"Cataline"},"license":"MIT","_id":"@cataline/facebook-conversion-api@0.4.0","maintainers":[{"name":"yungsilva","email":"yungsilva974@gmail.com"}],"homepage":"https://github.com/cataline/facebook-conversion-api#readme","bugs":{"url":"https://github.com/cataline/facebook-conversion-api/issues"},"dist":{"shasum":"c59729442be98472802d8641ac78df337f932e35","tarball":"https://registry.npmjs.org/@cataline/facebook-conversion-api/-/facebook-conversion-api-0.4.0.tgz","fileCount":8,"integrity":"sha512-m1p0A5cko6d7nc2PCxvTrht8mzRd2q6N83BhLk9PXdBUima5abv/4N6M26Unt7NxpJIwVW5wSQPsjQZFMaDlMA==","signatures":[{"sig":"MEUCIQC7iWsQxdcglJH3YRHLSohNZu/8wYULxBlxGZUGl+QlLgIgJJ/BkHdxiPviqqYz5OwrL154YM7WPvOMyxOVYzE/ZZU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":268845},"main":"./dist/facebook-conversion-api.umd.cjs","type":"module","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/facebook-conversion-api.js","require":"./dist/facebook-conversion-api.umd.cjs"}},"gitHead":"b4132c95b473e0cedf503cce79334fcf3572b832","scripts":{"dev":"vite","build":"tsc && vite build","preview":"vite preview"},"_npmUser":{"name":"yungsilva","email":"yungsilva974@gmail.com"},"repository":{"url":"git+https://github.com/cataline/facebook-conversion-api.git","type":"git"},"_npmVersion":"10.2.4","description":"> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)","directories":{},"_nodeVersion":"20.11.0","dependencies":{"ofetch":"^1.3.4","crypto-js":"^4.2.0"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.3.1","typescript":"^5.2.2","@types/node":"^20.14.9","vite-plugin-dts":"^3.9.1","@types/crypto-js":"^4.2.2"},"_npmOperationalInternal":{"tmp":"tmp/facebook-conversion-api_0.4.0_1720214435776_0.5748032089382795","host":"s3://npm-registry-packages"}},"0.4.1":{"name":"@cataline/facebook-conversion-api","version":"0.4.1","type":"module","scripts":{"dev":"vite","build":"tsc && vite build","preview":"vite preview"},"types":"./dist/index.d.ts","main":"./dist/facebook-conversion-api.umd.cjs","exports":{".":{"import":"./dist/facebook-conversion-api.js","require":"./dist/facebook-conversion-api.umd.cjs","types":"./dist/index.d.ts"}},"devDependencies":{"@types/crypto-js":"^4.2.2","@types/node":"^20.14.9","typescript":"^5.2.2","vite":"^5.3.1","vite-plugin-dts":"^3.9.1"},"dependencies":{"crypto-js":"^4.2.0","ofetch":"^1.3.4"},"author":{"name":"Cataline"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/cataline/facebook-conversion-api.git"},"keywords":["facebook","conversion","api"],"_id":"@cataline/facebook-conversion-api@0.4.1","gitHead":"67345b0f838462b161d09fcca3438dfa150dbd1c","description":"> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)","bugs":{"url":"https://github.com/cataline/facebook-conversion-api/issues"},"homepage":"https://github.com/cataline/facebook-conversion-api#readme","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-bALbXyM4cOENwqEgHNiGGLz/kdjO7oDX0unnjImDiXvLED/G4mKHwxQxgRTtLFhLRgDF6pTNdqFd2KC8rgpBnQ==","shasum":"55f4ef6e198b4fe886680502731ab42b9ee02ff4","tarball":"https://registry.npmjs.org/@cataline/facebook-conversion-api/-/facebook-conversion-api-0.4.1.tgz","fileCount":8,"unpackedSize":268535,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE5Q/d6PSYCwt4Ctno1FrVbM62FV4QsbSt36x6Um2lCEAiBEGx5CDD73jj4x9zLoegxuG7cfPY11Avf3z6w0wkSCFA=="}]},"_npmUser":{"name":"yungsilva","email":"yungsilva974@gmail.com"},"directories":{},"maintainers":[{"name":"yungsilva","email":"yungsilva974@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/facebook-conversion-api_0.4.1_1720222045389_0.9414574584048796"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-30T19:41:31.329Z","modified":"2024-07-05T23:27:25.811Z","0.1.0":"2024-06-30T19:41:31.631Z","0.2.0":"2024-07-05T17:57:57.895Z","0.3.0":"2024-07-05T20:50:35.654Z","0.4.0":"2024-07-05T21:20:35.971Z","0.4.1":"2024-07-05T23:27:25.608Z"},"maintainers":[{"name":"yungsilva","email":"yungsilva974@gmail.com"}],"author":{"name":"Cataline"},"repository":{"type":"git","url":"git+https://github.com/cataline/facebook-conversion-api.git"},"keywords":["facebook","conversion","api"],"license":"MIT","homepage":"https://github.com/cataline/facebook-conversion-api#readme","bugs":{"url":"https://github.com/cataline/facebook-conversion-api/issues"},"readme":"# Facebook Conversion API\n\n> Node.js wrapper for [Facebook's Conversion API](https://developers.facebook.com/docs/marketing-api/conversions-api/)\n\nThis JS/TS library allows you to track events with Facebook's Conversion API, whether on the **client-side** or **server-side**, helping you capture more accurate data for your Facebook ad campaigns.\n\n## Install\n\n```bash\nnpm install @cataline/facebook-conversion-api\n```\n\n## Usage\n\nSet up the library with your credentials and settings.\n\n```ts\nimport { facebookConversionAPI } from '@cataline/facebook-conversion-api'\n\nfacebookConversionAPI.init({\n  accessToken: 'YOUR_ACCESS_TOKEN',\n  pixelId: 'YOUR_PIXEL_ID',\n  actionSource: 'website',\n})\n```\n\nRead more on how to get your [access token](https://developers.facebook.com/docs/marketing-api/conversions-api/get-started/#access-token).\n\n## Setting User Data\n\nThe more user information you provide, the better the event attribution.\n\n```ts\nfacebookConversionAPI.setUserData({\n  emails: ['email_1@example.com', 'email_2@example.com'],\n  phones: ['+1234567890', '+0987654321'],\n  firstName: 'john',\n  lastName: 'doe',\n  dateOfBirth: '19970216',\n  gender: 'm',\n  city: 'São Paulo',\n  state: 'SP',\n  zip: '01100000',\n  country: 'br',\n  clientIpAddress: '192.168.1.1',\n  clientUserAgent: navigator.userAgent,\n  fbc: 'fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890',\n  fbp: 'fb.1.1558571054389.1098115397',\n  facebookLoginId: '1234567890',\n  externalId: '123456789',\n})\n```\n\nLearn how to obtain [fbp/fpc identifiers](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc/).\n\nWe will hash the required data using SHA-256, but you must provide the rest according to [Facebook’s documentation](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters) to ensure accurate and effective event tracking.\n\n## Sending Events\n\nSend events to Facebook Conversion API. This method supports all standard Facebook pixel events and custom events.\n\n```ts\nfacebookConversionAPI.trackEvent({\n  name: 'Purchase', // Use standard event name or custom event name\n  id: 'unique-event-id', // Optional: for deduplication\n  sourceUrl: 'https://your-site.com/thank-you',\n  params: {\n    currency: 'USD',\n    value: 99.99,\n    contents: [\n      {\n        id: 'product123',\n        quantity: 1,\n        delivery_category: 'home_delivery',\n      },\n    ],\n  },\n})\n```\n\n### Event Deduplication\n\nUnderstand how [event deduplication](https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events?locale=en_US) works using event IDs.\n\n## License\n\nThis project is licensed under the MIT License.\n","readmeFilename":"README.md"}