dataset_id
RequiredSecret
Type:
string
Description: ID of the Facebook dataset (formerly pixel) that receives the events, from the snippet on Facebook’s dataset creation page.
Notes:
{{ path || fallback }} template is accepted in place of a literal.access_token
RequiredSecret
Type:
string
Description: Business access token from your Facebook Business account.
Notes:
{{ path || fallback }} template is accepted in place of a literal.Supply it as a {{ .VAR }} reference rather than a literal — see Secrets.
action_source
Type:
string
Default value:
website
Description:
Fallback action_source sent to Facebook when an event’s properties don’t carry one.
Notes:
website, email, app, phone_call, chat, physical_store, system_generated, or other.events_to_events
Type:
array of objects
Description: Maps RudderStack event names to Facebook standard events. Events without a mapping follow the default mapping in Standard events mapping.
Notes:
from — RudderStack event name. At most 100 characters, and must not contain line breaks.to — one of ViewContent, Search, AddToCart, AddToWishlist, InitiateCheckout, AddPaymentInfo, Purchase, PageView, Lead, CompleteRegistration, Contact, CustomizeProduct, Donate, FindLocation, Schedule, StartTrial, SubmitApplication, or Subscribe.{{ path || fallback }} template in place of a literal.events_to_events:
- from: Order Completed
to: Purchasetest_destination
Type:
boolean
Default value:
false
Description: Use this destination for testing, so events appear in real time under Test Events in your Facebook dashboard.
test_event_code
Type:
string
Description: Test event code from your Facebook dataset’s Test Events tab.
Notes:
test_destination is true. Leave it unset otherwise.{{ path || fallback }} template is accepted in place of a literal.limited_data_usage
Type:
boolean
Default value:
false
Description:
Forward the event’s context.dataProcessingOptions to Facebook as data_processing_options, data_processing_options_country, and data_processing_options_state — Meta’s Limited Data Use flags.
remove_external_id
Type:
boolean
Default value:
false
Description:
Stop sending userId or anonymousId as external_id. When true, neither is sent. This is what the dashboard calls Don’t send external_id for user.
blacklist_pii_properties
Type:
array of objects
Description:
Standard PII fields to drop — or, with hash: true, to SHA-256 hash and send. Every standard PII field is denylisted by default, so an entry here matters mainly to turn on hashing.
Notes:
property — the PII field name. At most 100 characters, and must not contain line breaks. A template is accepted.hash — boolean. true hashes the field and sends it; false or unset drops it.blacklist_pii_properties:
- property: email
hash: true
- property: phone
hash: trueAn event whose integrations.fb_conversions.hashed is true is treated as already hashed and isn’t hashed again. See Allowlist/denylist PII.
whitelist_pii_properties
Type:
array of objects
Description: Standard PII fields to send as they are, when present in the event’s properties.
Notes:
property — the PII field name. At most 100 characters, and must not contain line breaks. A template is accepted.whitelist_pii_properties:
- property: city
- property: countryconnection_mode
Type:
object
Description: Maps each source type you connect to the mode its events reach Facebook in, using the modes in Source types.
Notes:
connection_mode:
web: cloud
cloud: cloudconsent_management
Type:
object
Description:
Consent provider configuration per source type. The entry shape, accepted providers, and the rules on resolution_strategy and consents are shared across all destination types — see Consent management.
| Version | Change |
|---|---|
| v0.29.0 | Breaking: A null config value, written as key: null, key: ~, or key: with no value, fails validate with '<key>' must not be null; set a value or remove the key. Earlier releases accepted it: a top-level null planned an update on every apply, and a null inside a list item failed at the API.What to do: Remove the key to leave it unset, or give it a value. |
| v0.29.0 | Breaking: An empty string, "", on a key that takes one of a fixed set of values fails validate with '<key>' must be one of [...], unless "" is one of the key’s values. Earlier releases accepted it, and the API rejected it at apply.What to do: Remove the key to leave it unset, or set one of the listed values. |
| v0.29.0 | Changed: validate warns when a secret key holds anything but one {{ .VAR }} reference with no default, and when one variable fills two secret keys. It also masks secret values in the lines it prints. |
| v0.29.0 | Changed: rudder-cli import writes each secret reference single-quoted, as '{{ .VAR }}', so a value containing double quotes, like a JSON key file, substitutes as a string. A single quote in a value that fills such a reference is written as ''.What to do: In a spec imported by an earlier release, quote each reference to a JSON value by hand: '{{ .VAR }}'. |
| v0.29.0 | Changed: validate reports a value of the wrong type once per key, such as 'email' must be a string, instead of one raw decoding error. |
| v0.28.0 | Added: warehouse source type, for destinations connected to a Reverse ETL source. Set connection_mode.warehouse: cloud for such a destination, or apply removes the entry. |