{"componentChunkName":"component---src-templates-integrations-template-jsx","path":"/integrations/spotify/event/","result":{"data":{"currPageMetadata":{"title":"Event","path":"/integrations/spotify/event/","sourceCode":null,"metadataParent":{"title":"Spotify","path":"/integrations/spotify/","sourceCode":null,"hasVersionPicker":null,"metadataChildren":[{"title":"Event","path":"/integrations/spotify/event/","order":1,"label":null}],"metadataParent":{"title":"Integrations","path":"/integrations/","metadataChildren":[{"title":null,"path":"/integrations/verizon-media/","order":null,"label":null},{"title":"24i","path":"/integrations/24i/","order":null,"label":null},{"title":"Aarki","path":"/integrations/aarki/","order":null,"label":null},{"title":"ABTasty","path":"/integrations/abtasty/","order":null,"label":null},{"title":"Actable","path":"/integrations/actable/","order":null,"label":null},{"title":"AdChemix","path":"/integrations/adchemix/","order":null,"label":null},{"title":"Adikteev","path":"/integrations/adikteev/","order":null,"label":null},{"title":"Adjust","path":"/integrations/adjust/","order":null,"label":null},{"title":"AdMedia","path":"/integrations/admedia/","order":null,"label":null},{"title":"Adobe Audience Manager","path":"/integrations/adobe-audience-manager/","order":null,"label":null},{"title":"Adobe Campaign Manager","path":"/integrations/adobe-campaign-manager/","order":null,"label":null},{"title":"Adobe Experience Platform","path":"/integrations/adobe-experience-platform/","order":null,"label":null},{"title":"Adobe Marketing Cloud","path":"/integrations/adobe/","order":null,"label":null},{"title":"Adobe Target","path":"/integrations/adobe-target/","order":null,"label":null},{"title":"AdPredictive","path":"/integrations/adpredictive/","order":null,"label":null},{"title":"AgilOne","path":"/integrations/agilone/","order":null,"label":null},{"title":"Airship","path":"/integrations/airship/","order":null,"label":null},{"title":"Algolia","path":"/integrations/algolia/","order":null,"label":null},{"title":"Amazon Advertising","path":"/integrations/amazon-advertising/","order":null,"label":null},{"title":"Amazon Kinesis","path":"/integrations/amazon-kinesis/","order":null,"label":null},{"title":"Amazon Kinesis Firehose","path":"/integrations/amazon-kinesis-firehose/","order":null,"label":null},{"title":"Amazon Redshift","path":"/integrations/amazon-redshift/","order":null,"label":null},{"title":"Amazon S3","path":"/integrations/amazons3/","order":null,"label":null},{"title":"Amazon SNS","path":"/integrations/amazonsns/","order":null,"label":null},{"title":"Amazon SQS","path":"/integrations/amazonsqs/","order":null,"label":null},{"title":"Amobee","path":"/integrations/amobee/","order":null,"label":null},{"title":"Amplitude","path":"/integrations/amplitude/","order":null,"label":null},{"title":"Ampush","path":"/integrations/ampush/","order":null,"label":null},{"title":"Analytics","path":"/integrations/analytics/","order":null,"label":null},{"title":"Anodot","path":"/integrations/anodot/","order":null,"label":null},{"title":"Antavo","path":"/integrations/antavo/","order":null,"label":null},{"title":"AppLovin","path":"/integrations/applovin/","order":null,"label":null},{"title":"AppsFlyer","path":"/integrations/appsflyer/","order":null,"label":null},{"title":"Apptentive","path":"/integrations/apptentive/","order":null,"label":null},{"title":"Apptimize","path":"/integrations/apptimize/","order":null,"label":null},{"title":"Apteligent","path":"/integrations/apteligent/","order":null,"label":null},{"title":"Attentive","path":"/integrations/attentive/","order":null,"label":null},{"title":"Awin","path":"/integrations/awin/","order":null,"label":null},{"title":"Batch","path":"/integrations/batch/","order":null,"label":null},{"title":"Bidease","path":"/integrations/bidease/","order":null,"label":null},{"title":"Bing Ads","path":"/integrations/bing/","order":null,"label":null},{"title":"Bluecore","path":"/integrations/bluecore/","order":null,"label":null},{"title":"Bluedot","path":"/integrations/bluedot/","order":null,"label":null},{"title":"Blueshift","path":"/integrations/blueshift/","order":null,"label":null},{"title":"Branch","path":"/integrations/branch-metrics/","order":null,"label":null},{"title":"Branch S2S Event","path":"/integrations/branch-metrics-server/","order":null,"label":null},{"title":"Braze","path":"/integrations/braze/","order":null,"label":null},{"title":"Bugsnag","path":"/integrations/bugsnag/","order":null,"label":null},{"title":"Button","path":"/integrations/button/","order":null,"label":null},{"title":"Cadent","path":"/integrations/cadent/","order":null,"label":null},{"title":"Census","path":"/integrations/census/","order":null,"label":null},{"title":"CleverTap","path":"/integrations/clevertap/","order":null,"label":null},{"title":"comScore","path":"/integrations/comscore/","order":null,"label":null},{"title":"Conversant","path":"/integrations/conversant/","order":null,"label":null},{"title":"Cordial","path":"/integrations/cordial/","order":null,"label":null},{"title":"Cortex","path":"/integrations/cortex/","order":null,"label":null},{"title":"Criteo","path":"/integrations/criteo/","order":null,"label":null},{"title":"Crossing Minds","path":"/integrations/crossing-minds/","order":null,"label":null},{"title":"Custom Feed","path":"/integrations/custom-feed/","order":null,"label":null},{"title":"Customer.io","path":"/integrations/customerio/","order":null,"label":null},{"title":"CustomerGlu","path":"/integrations/customerglu/","order":null,"label":null},{"title":"Databricks","path":"/integrations/databricks/","order":null,"label":null},{"title":"Datadog","path":"/integrations/datadog/","order":null,"label":null},{"title":"Didomi","path":"/integrations/didomi/","order":null,"label":null},{"title":"Dynamic Yield","path":"/integrations/dynamic-yield/","order":null,"label":null},{"title":"Eagle Eye","path":"/integrations/eagleeye/","order":null,"label":null},{"title":"Edge226","path":"/integrations/edge226/","order":null,"label":null},{"title":"Emarsys","path":"/integrations/emarsys/","order":null,"label":null},{"title":"Epsilon","path":"/integrations/epsilon/","order":null,"label":null},{"title":"Everflow","path":"/integrations/everflow/","order":null,"label":null},{"title":"Facebook","path":"/integrations/facebook/","order":null,"label":null},{"title":"Facebook Offline Conversions","path":"/integrations/facebook-offline-conversions/","order":null,"label":null},{"title":"Flurry","path":"/integrations/flurry/","order":null,"label":null},{"title":"Flybits","path":"/integrations/flybits/","order":null,"label":null},{"title":"ForeSee","path":"/integrations/foresee/","order":null,"label":null},{"title":"Foursquare","path":"/integrations/foursquare/","order":null,"label":null},{"title":"FreeWheel Data Suite","path":"/integrations/freewheel/","order":null,"label":null},{"title":"Friendbuy","path":"/integrations/friendbuy/","order":null,"label":null},{"title":"Google Ad Manager","path":"/integrations/google-ad-manager/","order":null,"label":null},{"title":"Google Ads","path":"/integrations/google-ads/","order":null,"label":null},{"title":"Google Analytics","path":"/integrations/google-analytics/","order":null,"label":null},{"title":"Google Analytics 4","path":"/integrations/google-analytics-4/","order":null,"label":null},{"title":"Google Analytics for Firebase","path":"/integrations/firebase/","order":null,"label":null},{"title":"Google BigQuery","path":"/integrations/google-bigquery/","order":null,"label":null},{"title":"Google Cloud Storage","path":"/integrations/google-cloud-storage/","order":null,"label":null},{"title":"Google Enhanced Conversions","path":"/integrations/google-enhanced-conversions/","order":null,"label":null},{"title":"Google Marketing Platform","path":"/integrations/google-marketing-platform/","order":null,"label":null},{"title":"Google Marketing Platform Offline Conversions","path":"/integrations/google-marketing-platform-offline/","order":null,"label":null},{"title":"Google Pub/Sub","path":"/integrations/google-pubsub/","order":null,"label":null},{"title":"Google Tag Manager","path":"/integrations/google-tag-manager/","order":null,"label":null},{"title":"Heap","path":"/integrations/heap/","order":null,"label":null},{"title":"Herow","path":"/integrations/herow/","order":null,"label":null},{"title":"Hightouch","path":"/integrations/hightouch/","order":null,"label":null},{"title":"Hyperlocology","path":"/integrations/hyperlocology/","order":null,"label":null},{"title":"Ibotta","path":"/integrations/ibotta/","order":null,"label":null},{"title":"ID5","path":"/integrations/id5/","order":null,"label":null},{"title":"Impact","path":"/integrations/impact/","order":null,"label":null},{"title":"InMarket","path":"/integrations/inmarket/","order":null,"label":null},{"title":"InMobi","path":"/integrations/inmobi/","order":null,"label":null},{"title":"Insider","path":"/integrations/insider/","order":null,"label":null},{"title":"Inspectlet","path":"/integrations/inspectlet/","order":null,"label":null},{"title":"Intercom","path":"/integrations/intercom/","order":null,"label":null},{"title":"iPost","path":"/integrations/ipost/","order":null,"label":null},{"title":"ironSource","path":"/integrations/ironsource/","order":null,"label":null},{"title":"Iterable","path":"/integrations/iterable/","order":null,"label":null},{"title":"Jampp","path":"/integrations/jampp/","order":null,"label":null},{"title":"Kafka","path":"/integrations/kafka/","order":null,"label":null},{"title":"Kayzen","path":"/integrations/kayzen/","order":null,"label":null},{"title":"Kissmetrics","path":"/integrations/kissmetrics/","order":null,"label":null},{"title":"Klaviyo","path":"/integrations/klaviyo/","order":null,"label":null},{"title":"Kochava","path":"/integrations/kochava/","order":null,"label":null},{"title":"Kubit","path":"/integrations/kubit/","order":null,"label":null},{"title":"LaunchDarkly","path":"/integrations/launchdarkly/","order":null,"label":null},{"title":"Leanplum","path":"/integrations/leanplum/","order":null,"label":null},{"title":"LifeStreet","path":"/integrations/lifestreet/","order":null,"label":null},{"title":"Liftoff","path":"/integrations/liftoff/","order":null,"label":null},{"title":"LinkedIn","path":"/integrations/linkedin/","order":null,"label":null},{"title":"LiveLike","path":"/integrations/livelike/","order":null,"label":null},{"title":"Liveramp","path":"/integrations/liveramp/","order":null,"label":null},{"title":"Localytics","path":"/integrations/localytics/","order":null,"label":null},{"title":"MadHive","path":"/integrations/madhive/","order":null,"label":null},{"title":"mAdme Technologies","path":"/integrations/madme/","order":null,"label":null},{"title":"Mailchimp","path":"/integrations/mailchimp/","order":null,"label":null},{"title":"Marigold","path":"/integrations/marigold/","order":null,"label":null},{"title":"Mautic","path":"/integrations/mautic/","order":null,"label":null},{"title":"MediaMath","path":"/integrations/mediamath/","order":null,"label":null},{"title":"Mediasmart","path":"/integrations/mediasmart/","order":null,"label":null},{"title":"Microsoft Ads","path":"/integrations/microsoft/","order":null,"label":null},{"title":"Microsoft Azure Blob Storage","path":"/integrations/azure-blob-storage/","order":null,"label":null},{"title":"Microsoft Azure Event Hubs","path":"/integrations/microsoft-azure-event-hubs/","order":null,"label":null},{"title":"Mintegral","path":"/integrations/mintegral/","order":null,"label":null},{"title":"Mixpanel","path":"/integrations/mixpanel/","order":null,"label":null},{"title":"MoEngage","path":"/integrations/moengage/","order":null,"label":null},{"title":"Moloco","path":"/integrations/moloco/","order":null,"label":null},{"title":"Monetate","path":"/integrations/monetate/","order":null,"label":null},{"title":"Movable Ink","path":"/integrations/movableink/","order":null,"label":null},{"title":"Movable Ink - V2","path":"/integrations/movableink-v2/","order":null,"label":null},{"title":"Multiplied","path":"/integrations/multiplied/","order":null,"label":null},{"title":"myTarget","path":"/integrations/mytarget/","order":null,"label":null},{"title":"Nami ML","path":"/integrations/nami-ml/","order":null,"label":null},{"title":"Nanigans","path":"/integrations/nanigans/","order":null,"label":null},{"title":"Narrative","path":"/integrations/narrative/","order":null,"label":null},{"title":"NCR Aloha","path":"/integrations/ncr-aloha/","order":null,"label":null},{"title":"Neura","path":"/integrations/neura/","order":null,"label":null},{"title":"OneTrust","path":"/integrations/onetrust/","order":null,"label":null},{"title":"Optimizely","path":"/integrations/optimizely/","order":null,"label":null},{"title":"Oracle BlueKai","path":"/integrations/oracle-bluekai/","order":null,"label":null},{"title":"Oracle Responsys","path":"/integrations/oracle-responsys/","order":null,"label":null},{"title":"Paytronix","path":"/integrations/paytronix/","order":null,"label":null},{"title":"Persona.ly","path":"/integrations/persona/","order":null,"label":null},{"title":"Personify XP","path":"/integrations/personify-xp/","order":null,"label":null},{"title":"PieEye","path":"/integrations/pieeye/","order":null,"label":null},{"title":"Pilgrim","path":"/integrations/pilgrim/","order":null,"label":null},{"title":"Pinterest","path":"/integrations/pinterest/","order":null,"label":null},{"title":"Plarin","path":"/integrations/plarin/","order":null,"label":null},{"title":"Postie","path":"/integrations/postie/","order":null,"label":null},{"title":"Primer","path":"/integrations/primer/","order":null,"label":null},{"title":"Punchh","path":"/integrations/punchh/","order":null,"label":null},{"title":"Pushwoosh","path":"/integrations/pushwoosh/","order":null,"label":null},{"title":"Qualtrics","path":"/integrations/qualtrics/","order":null,"label":null},{"title":"Quantcast","path":"/integrations/quantcast/","order":null,"label":null},{"title":"Radar","path":"/integrations/radar/","order":null,"label":null},{"title":"Rakuten","path":"/integrations/rakuten/","order":null,"label":null},{"title":"Reddit","path":"/integrations/reddit/","order":null,"label":null},{"title":"Regal","path":"/integrations/regal/","order":null,"label":null},{"title":"Remerge","path":"/integrations/remerge/","order":null,"label":null},{"title":"Retina AI","path":"/integrations/retina-ai/","order":null,"label":null},{"title":"Reveal Mobile","path":"/integrations/reveal-mobile/","order":null,"label":null},{"title":"RevenueCat","path":"/integrations/revenuecat/","order":null,"label":null},{"title":"Rokt","path":"/integrations/rokt/","order":null,"label":null},{"title":"RTB House","path":"/integrations/rtb-house/","order":null,"label":null},{"title":"Sailthru","path":"/integrations/sailthru/","order":null,"label":null},{"title":"Salesforce Email","path":"/integrations/salesforce-email/","order":null,"label":null},{"title":"Salesforce Mobile Push","path":"/integrations/salesforce-mobile-push/","order":null,"label":null},{"title":"Salesforce Sales and Service Cloud","path":"/integrations/salesforce-sales-cloud/","order":null,"label":null},{"title":"Samba TV","path":"/integrations/samba-tv/","order":null,"label":null},{"title":"Scalarr","path":"/integrations/scalarr/","order":null,"label":null},{"title":"SendGrid","path":"/integrations/sendgrid/","order":null,"label":null},{"title":"SessionM","path":"/integrations/sessionm/","order":null,"label":null},{"title":"SFTP","path":"/integrations/sftp/","order":null,"label":null},{"title":"ShareThis","path":"/integrations/sharethis/","order":null,"label":null},{"title":"Shopify","path":"/integrations/shopify/","order":null,"label":null},{"title":"SimpleReach","path":"/integrations/simplereach/","order":null,"label":null},{"title":"Singular","path":"/integrations/singular/","order":null,"label":null},{"title":"Singular-DEPRECATED","path":"/integrations/singular-deprecated/","order":null,"label":null},{"title":"Skyhook","path":"/integrations/skyhook/","order":null,"label":null},{"title":"Slack","path":"/integrations/slack/","order":null,"label":null},{"title":"Smadex","path":"/integrations/smadex/","order":null,"label":null},{"title":"SmarterHQ","path":"/integrations/smarterhq/","order":null,"label":null},{"title":"Snapchat","path":"/integrations/snapchat/","order":null,"label":null},{"title":"Snapchat Conversions","path":"/integrations/snapchat-conversions/","order":null,"label":null},{"title":"Snowflake","path":"/integrations/snowflake/","order":null,"label":null},{"title":"Snowplow","path":"/integrations/snowplow/","order":null,"label":null},{"title":"Split","path":"/integrations/split/","order":null,"label":null},{"title":"Splunk MINT","path":"/integrations/splunk-mint/","order":null,"label":null},{"title":"Spotify","path":"/integrations/spotify/","order":null,"label":null},{"title":"Sprig","path":"/integrations/sprig/","order":null,"label":null},{"title":"StartApp","path":"/integrations/startapp/","order":null,"label":null},{"title":"Statsig","path":"/integrations/statsig/","order":null,"label":null},{"title":"Stormly","path":"/integrations/stormly/","order":null,"label":null},{"title":"Swrve","path":"/integrations/swrve/","order":null,"label":null},{"title":"Talon.One","path":"/integrations/talon-one/","order":null,"label":null},{"title":"Tapad","path":"/integrations/tapad/","order":null,"label":null},{"title":"Tapjoy","path":"/integrations/tapjoy/","order":null,"label":null},{"title":"Taplytics","path":"/integrations/taplytics/","order":null,"label":null},{"title":"Taptica","path":"/integrations/taptica/","order":null,"label":null},{"title":"Teak","path":"/integrations/teak/","order":null,"label":null},{"title":"The Trade Desk","path":"/integrations/the-trade-desk/","order":null,"label":null},{"title":"Ticketure","path":"/integrations/ticketure/","order":null,"label":null},{"title":"TikTok Event","path":"/integrations/tiktok/","order":null,"label":null},{"title":"Treasure Data","path":"/integrations/treasure-data/","order":null,"label":null},{"title":"Triton Digital","path":"/integrations/triton-digital/","order":null,"label":null},{"title":"TUNE","path":"/integrations/tune/","order":null,"label":null},{"title":"Twitter","path":"/integrations/twitter/","order":null,"label":null},{"title":"Valid","path":"/integrations/valid/","order":null,"label":null},{"title":"Vibe","path":"/integrations/vibe/","order":null,"label":null},{"title":"Vkontakte","path":"/integrations/vkontakte/","order":null,"label":null},{"title":"Voucherify","path":"/integrations/voucherify/","order":null,"label":null},{"title":"Vungle","path":"/integrations/vungle/","order":null,"label":null},{"title":"Webhook","path":"/integrations/webhook/","order":null,"label":null},{"title":"Webtrends","path":"/integrations/webtrends/","order":null,"label":null},{"title":"White Label Loyalty","path":"/integrations/whitelabelloyalty/","order":null,"label":null},{"title":"Wootric","path":"/integrations/wootric/","order":null,"label":null},{"title":"X","path":"/integrations/x/","order":null,"label":null},{"title":"Xandr","path":"/integrations/xandr/","order":null,"label":null},{"title":"Yahoo (formerly Verizon Media)","path":"/integrations/yahoo/","order":null,"label":null},{"title":"Yotpo","path":"/integrations/yotpo/","order":null,"label":null},{"title":"YouAppi","path":"/integrations/youappi/","order":null,"label":null},{"title":"Z2A Digital","path":"/integrations/z2adigital/","order":null,"label":null},{"title":"Zendesk","path":"/integrations/zendesk/","order":null,"label":null}],"metadataParent":null},"partnerId":185}},"markdownRemark":{"html":"

Spotify is an audio streaming platform whose advertising business, Spotify Ads, reaches listeners across music, podcasts, and audiobooks. The Spotify Conversions API (CAPI) is a server-to-server integration that lets you send conversion events directly to Spotify, without relying solely on a client-side pixel. Forwarding conversions server-side improves signal fidelity and attribution accuracy as browser tracking restrictions, cookie deprecation, and ad blockers continue to limit pixel-based measurement.

\n

This integration is a server-side output only. Client-side forwarding via kit is not supported.

\n

\n \n \n \n \n \n \n \n Prerequisites

\n

To set up the Spotify event integration, you need:

\n\n

The Conversions API access token is separate from the token used by other Spotify Ads API endpoints. Spotify allows a maximum of three active tokens per Conversions API data source; delete an existing token before generating another.

\n

\n \n \n \n \n \n \n \n Setup

\n

\n \n \n \n \n \n \n \n 1. Create a Spotify Conversions API data source

\n

You must be a Business Admin in Ads Manager to complete this step.

\n
    \n
  1. Log in to Spotify Ads Manager.
    2. \n
  2. Click the global navigation icon in the top left and select Events.
    3. \n
  3. Click Connect data source and select Conversions API.
    4. \n
  4. Name your integration and select the ad accounts to associate with it.
    5. \n
  5. Click Generate token and copy the access token.
    6. \n
  6. Copy the Connection ID, a UUID shown when the data source is created. To retrieve it later, open the data source and click View Instructions.
    7. \n
\n

\n \n \n \n \n \n \n \n 2. Create a Spotify output configuration

\n
    \n
  1. In mParticle, navigate to Data Platform > Setup > Outputs.
    2. \n
  2. On the Event tab, click Add Output and select Spotify.
    3. \n
  3. Enter a descriptive Configuration Name.
    4. \n
  4. Enter your CAPI Connection ID: the UUID from your Spotify Conversions API data source.
    5. \n
  5. Enter your CAPI Access Token: the bearer token generated for that data source. mParticle stores this value encrypted.
    6. \n
  6. Click Save.
    7. \n
\n

\n \n \n \n \n \n \n \n 3. Connect a data input to Spotify

\n

To connect an input:

\n
    \n
  1. In mParticle, navigate to Connections > Connect Outputs.
    2. \n
  2. Select the input you want to connect.
    3. \n
  3. Find Spotify in the output list and click Connect Output.
    4. \n
  4. Select an Action Source: where the conversions on this connection occur. Choose Web, App, or Offline.
    5. \n
  5. (Optional) Select a User Data Consent Mapping: the mParticle consent purpose whose state determines whether an event is opted out of Spotify retargeting.
    6. \n
  6. Click Add Connection.
    7. \n
\n

\n \n \n \n \n \n \n \n Supported platforms

\n\n

\n \n \n \n \n \n \n \n Supported identities

\n

Spotify requires at least one identifier on every conversion. mParticle builds the identifier set once per batch and attaches it to every event in that batch.

\n

\n \n \n \n \n \n \n \n Supported user identities

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Spotify FieldmParticle Identity TypeProcessing
hashed_emailsEmailTrimmed, lowercased, and SHA-256 hashed before forwarding. Values that are already hashed are passed through unchanged.
hashed_phone_numberMobile NumberTrimmed, lowercased, and SHA-256 hashed before forwarding. Values that are already hashed are passed through unchanged.
\n

If the Mobile Number identity is not present, mParticle falls back through Phone Number 2, then Phone Number 3, and finally the $Mobile user attribute. The first non-empty value found is hashed and forwarded.

\n

\n \n \n \n \n \n \n \n Supported device identities

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Spotify FieldmParticle Identity TypeProcessing
device_idiOS Advertising ID (IDFA), Google Advertising ID (GAID), or iOS Vendor ID (IDFV)Spotify accepts a single device ID. mParticle selects the first of these that is present, in the order listed, and SHA-256 hashes it before forwarding.
ip_addressClient IP address on the event batchForwarded unhashed.
\n\n

\n \n \n \n \n \n \n \n Supported event types

\n

mParticle forwards the following event types to Spotify:

\n\n

All supported event types are forwarded by default. This integration’s connection settings do not allow you to disable event forwarding for a specific event type, but you can disable event forwarding using Filters.

\n

Spotify identifies conversions by a fixed set of event names rather than by your event’s own name. mParticle resolves every event to one of these twelve names:

\n\n

\n \n \n \n \n \n \n \n Default event mappings

\n

These events forward with no configuration:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
mParticle EventSpotify Event Name
Screen ViewVIEW
Commerce Event: View DetailPRODUCT
Commerce Event: CheckoutCHECK_OUT
Commerce Event: Add to CartADD_TO_CART
Commerce Event: PurchasePURCHASE
\n

Commerce event subtypes without a default mapping, such as refund, remove from cart, and checkout option, are not forwarded unless you map them explicitly.

\n

\n \n \n \n \n \n \n \n Mapping other events

\n

Custom events are not forwarded unless you map them. Use Custom Mappings for your Spotify connection to map an event to one of the twelve Spotify event names. LEAD, SIGN_UP, and CUSTOM_EVENT_1 through CUSTOM_EVENT_5 have no default mapping and are available for any event you choose.

\n

A custom mapping always takes precedence over the default mapping. If you map a Purchase commerce event to CUSTOM_EVENT_1, mParticle forwards it as CUSTOM_EVENT_1 rather than PURCHASE. Events mapped to a name outside the twelve Spotify accepts are not forwarded.

\n

\n \n \n \n \n \n \n \n Event data mapping

\n

\n \n \n \n \n \n \n \n Event fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
mParticle FieldSpotify FieldNotes
Event IDevent_idmParticle’s unique identifier for the event.
Event timestampevent_timeISO 8601 UTC with milliseconds.
Resolved event nameevent_nameSee Supported event types.
Action Source connection settingaction_sourceWEB, APP, or OFFLINE.
Currency code (Commerce Event)event_details.currency
product_action.total_amount (Commerce Event)event_details.amount
Product names (Commerce Event)event_details.content_nameComma-separated when the event has multiple products.
Product categories (Commerce Event)event_details.content_categoryComma-separated when the event has multiple products.
Screen name (Screen View)event_details.content_nameThe name of the Screen View event.
\n

event_details is omitted entirely when none of its four fields have a value.

\n

For events forwarded through a custom mapping, event_details is built from the attributes you map to Currency, Amount, Content Name, and Content Category rather than from the event’s own commerce fields. All four are optional.

\n\n

\n \n \n \n \n \n \n \n Custom flags

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Custom FlagSpotify FieldNotes
Spotify.EventSourceUrlevent_source_urlThe URL where the conversion occurred. Must begin with http:// or https://; other values are dropped and a warning is logged.
Spotify.OptOutTargetingopt_out_targetingtrue or false. See Opt-out targeting.
\n

\n \n \n \n \n \n \n \n Custom mappings

\n

Custom Mappings are optional for commerce events and screen views, and required for custom events. Use them to select which Spotify event name an event maps to and to populate event_details. For general instructions, see Custom Mappings.

\n

\n \n \n \n \n \n \n \n Data processing notes

\n\n

\n \n \n \n \n \n \n \n Opt-out targeting

\n

The opt_out_targeting field tells Spotify to use a conversion for attribution only, excluding it from retargeting. mParticle resolves it per event in this order:

\n
    \n
  1. If the mapped consent purpose is present on the user’s profile and consent is denied, or the Spotify.OptOutTargeting custom flag is true, mParticle sends true.
    2. \n
  2. If the mapped consent purpose is granted, or the custom flag is false, mParticle sends false.
    3. \n
  3. Otherwise, the field is omitted from the event.
    4. \n
\n

You can map only one consent purpose per connection, and the mapped purpose cannot be empty. Saving a connection that violates either rule fails validation.

\n

\n \n \n \n \n \n \n \n Configuration settings

\n

Configuration settings authenticate mParticle with the Spotify Conversions API and are set at the output level.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Setting NameData TypeRequiredDefault ValueDescription
CAPI Connection IDstringYesThe UUID of your Conversions API data source. Found in Spotify Ads Manager under Events > your Conversions API data source > View Instructions.
CAPI Access TokenstringYesThe Conversions API access token generated in Spotify Ads Manager for the data source. Sent as a bearer token on every request. Stored encrypted by mParticle.
\n

\n \n \n \n \n \n \n \n Connection settings

\n

Connection settings are configured per connection and control how conversions from a given input are described to Spotify.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Setting NameData TypeRequiredDefault ValuePlatformDescription
Action SourcestringYesWebAllWhere the conversions on this connection occur. One of Web, App, or Offline. Forwarded as action_source.
User Data Consent MappingstringNoAllThe mParticle consent purpose that determines opt_out_targeting. When the purpose is on the user’s profile, denied consent opts the event out of Spotify retargeting. Only one purpose can be mapped.
","frontmatter":{"title":"Event","seoTitle":null,"seoDescription":null},"parent":{"__typename":"File","modifiedTime":"September 29, 2026"}}},"pageContext":{"slug":"/integrations/spotify/event/"}},"staticQueryHashes":["2950460867"]}