Facebook Conversions Destination Config Reference Beta

Facebook Conversions sends events to Meta’s Conversions API from RudderStack’s servers, so conversions reach Facebook without depending on the browser pixel.

In a Facebook Conversions destination spec:

• type: facebook_conversions
• definition_version: 1

Sample configuration

version: rudder/v1
kind: destination
metadata:
  name: fb-conversions-prod
spec:
  id: fb-conversions-prod
  display_name: Facebook Conversions Production
  type: facebook_conversions
  definition_version: 1
  enabled: true
  config:
    dataset_id: "{{ .FB_DATASET_ID }}"
    access_token: "{{ .FB_ACCESS_TOKEN }}"

    action_source: website
    events_to_events:
      - from: Order Completed
        to: Purchase
      - from: Product Added
        to: AddToCart

    test_destination: false
    limited_data_usage: false
    remove_external_id: false
    blacklist_pii_properties:
      - property: email
        hash: true
    whitelist_pii_properties:
      - property: city

    connection_mode:
      web: cloud
      cloud: cloud
    consent_management:
      web:
        - provider: oneTrust
          consents:
            - marketing

The above example hashes email instead of dropping it, and omits test_event_code because test_destination is false — see Testing and Privacy.

Config keys

config accepts only the keys listed below. The shared config key rules cover unknown keys, defaults, and immutability.

Facebook Conversions accepts only page, screen, and track events. It doesn’t accept identify — user data travels with each event instead.

Connection

Event settings

events_to_events:
  - from: Order Completed
    to: Purchase

Testing

The dashboard asks for test_event_code when test_destination is on. Rudder CLI doesn’t enforce that pairing, so a spec with test_destination: true and no code passes validate.

Privacy

The PII lists act only on Facebook’s standard PII fields — email, firstName, lastName, gender, city, country, phone, state, zip, birthday, and their variants. They don’t affect other properties, or whether userId and anonymousId are sent as external_id; remove_external_id controls that.

blacklist_pii_properties:
  - property: email
    hash: true
  - property: phone
    hash: true

whitelist_pii_properties:
  - property: city
  - property: country

Per-source keys

Both keys are objects keyed by the local source type — the tokens listed under Source types. A key naming a source type this destination doesn’t support fails validation.

connection_mode:
  web: cloud
  cloud: cloud

Source types

Facebook Conversions accepts events from these source types in the mentioned connection modes:

Every source type is cloud only — events reach Facebook from RudderStack’s servers, never in device mode. For browser-side tracking, use Facebook Pixel.

The dashboard additionally offers Facebook Conversions to AMP, Shopify, and Reverse ETL sources. Rudder CLI doesn’t manage those connections, so amp, shopify, and warehouse are invalid here.

Connect a source

An event stream connection to this destination is checked against two rules at validate time.

The source’s type must be supported. A source’s type resolves to one of the tokens above before the check — a JavaScript source resolves to web, and webhook and server-side SDK sources resolve to cloud. An unsupported type reports:

destination 'fb-conversions-prod' (type 'facebook_conversions') does not support source 'my-source':
source type 'amp' is not among supported source types: android, android_kotlin, ...

The destination config must carry a connection_mode entry for that source type. This lives on the destination spec, not on the connection spec. Without it:

destination 'fb-conversions-prod' config has no 'connection_mode' entry for source type 'web'

Facebook Conversions needs no additional config keys to connect a source of any type.

Secrets

access_token and dataset_id are the secret keys. Write each as a {{ .VAR }} reference and supply the value at apply time:

config:
  dataset_id: "{{ .FB_DATASET_ID }}"
  access_token: "{{ .FB_ACCESS_TOKEN }}"

export RUDDER_FB_ACCESS_TOKEN="..."
export RUDDER_FB_DATASET_ID="..."
rudder-cli apply

# or
rudder-cli apply --var-file secrets.vars.yaml

Note that:

• The YAML that rudder-cli import writes may or may not include secret keys. Before you apply, make sure every secret key your configuration needs is present and populated through variable substitution.

See How to Use Variable Substitution in Rudder CLI.

See more

• Facebook Conversions Destination for setup, fbc and fbp parameters, and FAQ
• Destination Type Reference for Rudder CLI for the rules shared across destination types
• Destination YAML Reference for the spec envelope