Layers

Standard Events

The canonical event list. Events in this list are forwarded to Meta CAPI and TikTok Events API. Others are stored but dropped at the relay.

View as Markdown

The Layers SDK accepts any event name via track('event_name', ...), but the server-side CAPI relay only forwards events that are in the mapping table below. Everything else is stored in sdk_events and visible in the Events page, but dropped at the relay.

Meta CAPI mapping

Layers eventMeta event
purchase_successPurchase
paywall_purchasedPurchase
subscription_startSubscribe
subscription_renewSubscribe
trial_startStartTrial
trial_convertSubscribe
sign_upCompleteRegistration
add_to_cartAddToCart
content_openViewContent
searchSearch
purchase_attemptInitiateCheckout
bookmark_addAddToWishlist

Anything not in the Meta column is not forwarded to Meta, even if it's otherwise a valid Layers event.

TikTok Events API mapping

Layers eventTikTok event
purchase_successPurchase
paywall_purchasedPurchase
subscription_startPurchase
trial_startPurchase
add_to_cartAddToCart
content_openViewContent
screen_viewPageView
searchSearch
sign_upCompleteRegistration

Events not in this column are dropped at the TikTok relay.

Per-app overrides

Each layer's CAPI config can declare an event_map override that takes precedence over the defaults above. Use this when you want to

  • add forwarding for a new SDK event name, or
  • remap an existing SDK event to a different platform event.

Overrides are set in the layer config and surfaced via the partner API.

Purchase:

layers.track('purchase_success', {
  revenue: 9.99,
  currency: 'USD',
  product_id: 'premium_yearly',
  transaction_id: 'txn_...',
  store: 'app_store',
});

The server relay extracts revenue / currency (or price / fallback properties) and forwards them as Meta's custom_data.value and TikTok's properties.value.

Search:

layers.track('search', { query: 'running shoes' });

Custom events

Anything not in the tables above is a custom event. It still stores in sdk_events and shows up in the Events page — but it is not forwarded to Meta or TikTok unless you add a per-app event_map entry for it. See custom events.

On this page