Use the search bar or the checkboxes below to find the events you need to use Currents effectively.
These schema consist of the Braze Events that are directly related to message sending.
Os esquemas de armazenamento se aplicam aos dados de eventos de arquivo simples que enviamos aos parceiros de armazenamento do Data Warehouse (Google Cloud Storage, Amazon S3 e Microsoft Azure Blob Storage). Para esquemas que se aplicam a outros parceiros, consulte nossa lista de parceiros disponíveis e verifique suas respectivas páginas.
Explicação da estrutura do evento de engajamento com mensagens e dos valores da plataforma
Estrutura do evento
Esse detalhamento do evento mostra que tipo de informação geralmente é incluído em um evento de engajamento com mensagem. Com uma sólida compreensão de seus componentes, seus desenvolvedores e a equipe de estratégia de business intelligence podem usar os dados de eventos Currents recebidos para criar relatórios e gráficos orientados por dados e tirar proveito de outras métricas de dados valiosas.
Os eventos de engajamento com mensagens são compostos por propriedades específicas do usuário, propriedades de rastreamento de campanha/canva e propriedades específicas do evento.
Esquema de ID de usuário
Note as convenções de nomenclatura para IDs de usuário.
Esquema do Braze
Esquema de Currents
Descrição
braze_id
"USER_ID"
O identificador exclusivo que é atribuído automaticamente pelo Braze.
external_id
"EXTERNAL_USER_ID"
O identificador exclusivo do perfil de um usuário que é definido pelo cliente.
Valores da plataforma
Certos eventos retornam um valor platform que especifica a plataforma do dispositivo do usuário.
A tabela a seguir detalha os possíveis valores retornados:
Dispositivo do usuário
Valor da plataforma
iOS
ios
Android
android
FireTV
kindle
Kindle
kindle
Web
web
tvOS
tvos
Roku
roku
important:
O Currents descartará eventos com cargas úteis excessivamente grandes, superiores a 900 KB.
note:
Os objetos relacionados ao Canvas Flow têm IDs que podem ser usados para agrupamento e traduzidos em nomes legíveis por meio do endpoint Exportar detalhes do Canvas.
note:
Alguns campos podem levar mais tempo para exibir seu estado mais recente após a atualização de uma campanha ou do Canva. Esses campos são:
"campaign_name" (nome da campanha)
"canvas_name"
"canvas_step_name"
"conversion_behavior" (comportamento de conversão)
"canvas_variation_name" (nome da variação da tela)
"experiment_split_name"
"message_variation_name" (nome da variação da mensagem)
Se for necessária uma consistência completa, recomendamos aguardar uma hora a partir da última atualização desses campos antes de enviar as mensagens aos usuários.
Eventos lidos pelo WhatsApp
Esse evento ocorre quando uma mensagem do WhatsApp é lida pelo usuário final.
//WhatsAppRead:users.messages.whatsapp.Read{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//WhatsAppRead:users.messages.whatsapp.Read{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WhatsAppRead:users.messages.whatsapp.Read{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, long) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WhatsAppRead:users.messages.whatsapp.Read{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, long) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WhatsAppRead:users.messages.whatsapp.Read{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, long) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de entrega do WhatsApp
Esse evento ocorre quando uma mensagem do WhatsApp enviada chega com êxito ao dispositivo do usuário final.
//WhatsAppDelivery:users.messages.whatsapp.Delivery{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//WhatsAppDelivery:users.messages.whatsapp.Delivery{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WhatsAppDelivery:users.messages.whatsapp.Delivery{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, long) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WhatsAppDelivery:users.messages.whatsapp.Delivery{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, long) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WhatsAppDelivery:users.messages.whatsapp.Delivery{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, long) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de falha do WhatsApp
Esse evento ocorre quando o WhatsApp não consegue entregar a mensagem ao usuário. Um hard bounce significa uma falha permanente de entregabilidade.
//WhatsAppFailure:users.messages.whatsapp.Failure{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(required, string) Error code from WhatsApp","provider_error_title":"(required, string) Description of error from WhatsApp","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//WhatsAppFailure:users.messages.whatsapp.Failure{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(required, string) Error code from WhatsApp","provider_error_title":"(required, string) Description of error from WhatsApp","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WhatsAppFailure:users.messages.whatsapp.Failure{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(required, string) Error code from WhatsApp","provider_error_title":"(required, string) Description of error from WhatsApp","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, long) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WhatsAppFailure:users.messages.whatsapp.Failure{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(required, string) Error code from WhatsApp","provider_error_title":"(required, string) Description of error from WhatsApp","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, long) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WhatsAppFailure:users.messages.whatsapp.Failure{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(required, string) Error code from WhatsApp","provider_error_title":"(required, string) Description of error from WhatsApp","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, long) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de envio do WhatsApp
Esse evento ocorre quando uma solicitação de envio foi comunicada com êxito entre o Braze e o WhatsApp. No entanto, isso não significa que a mensagem foi recebida pelo usuário final.
//WhatsAppSend:users.messages.whatsapp.Send{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//WhatsAppSend:users.messages.whatsapp.Send{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WhatsAppSend:users.messages.whatsapp.Send{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, long) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WhatsAppSend:users.messages.whatsapp.Send{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, long) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WhatsAppSend:users.messages.whatsapp.Send{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(required, string) Phone number used to send in e.164 format (for example +14155552671)","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, long) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de mensagens de cancelamento do WhatsApp
Esse evento ocorre se uma mensagem do WhatsApp foi abortada com base em abortos Liquid, Horário de silêncio, etc.
//WhatsAppAbort:users.messages.whatsapp.Abort{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//WhatsAppAbort:users.messages.whatsapp.Abort{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WhatsAppAbort:users.messages.whatsapp.Abort{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, long) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WhatsAppAbort:users.messages.whatsapp.Abort{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, long) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WhatsAppAbort:users.messages.whatsapp.Abort{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, long) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos recebidos de entrada do WhatsApp
Esse evento ocorre quando um dos seus usuários envia uma mensagem do WhatsApp para um número de telefone em um dos seus grupos de inscrições do Braze WhatsApp.
//WhatsAppInboundReceived:users.messages.whatsapp.InboundReceive{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","quick_reply_text":"(optional, string) Text of button pressed by the user","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token","user_phone_number":"(required, string) The user's phone number from which the message was received"}}
//WhatsAppInboundReceived:users.messages.whatsapp.InboundReceive{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","quick_reply_text":"(optional, string) Text of button pressed by the user","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, long) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(optional, string) Braze user ID of the user who performed this event","user_phone_number":"(required, string) The user's phone number from which the message was received"}
//WhatsAppInboundReceived:users.messages.whatsapp.InboundReceive{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","inbound_phone_number":"(required, string) The inbound number that the message was sent to","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","quick_reply_text":"(optional, string) Text of button pressed by the user","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, long) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) The user's phone number from which the message was received"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WhatsAppInboundReceived:users.messages.whatsapp.InboundReceive{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","quick_reply_text":"(optional, string) Text of button pressed by the user","subscription_group_id":"(optional, string) Subscription group API ID","user_phone_number":"(required, string) The user's phone number from which the message was received"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, long) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WhatsAppInboundReceived:users.messages.whatsapp.InboundReceive{"context":{"traits":{"phone":"(required, string) The user's phone number from which the message was received"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","quick_reply_text":"(optional, string) Text of button pressed by the user","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, long) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de mensagem de abortamento do cartão de conteúdo
Esse evento ocorre se uma mensagem do cartão de conteúdo foi abortada com base em abortos Liquid, horários de silêncio etc.
//ContentCardAbort:users.messages.contentcard.Abort{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//ContentCardAbort:users.messages.contentcard.Abort{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ContentCardAbort:users.messages.contentcard.Abort{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ContentCardAbort:users.messages.contentcard.Abort{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ContentCardAbort:users.messages.contentcard.Abort{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de mensagens de cancelamento de e-mail
Esse evento ocorre se uma mensagem de e-mail foi abortada com base em abortos Liquid, Horário de silêncio, etc.
//EmailAbort:users.messages.email.Abort{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//EmailAbort:users.messages.email.Abort{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailAbort:users.messages.email.Abort{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailAbort:users.messages.email.Abort{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailAbort:users.messages.email.Abort{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de abortamento de notificações por push
Esse evento ocorre se uma mensagem de notificação por push foi abortada com base em Liquid aborts, Horário de silêncio, etc.
//PushNotificationAbort:users.messages.pushnotification.Abort{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//PushNotificationAbort:users.messages.pushnotification.Abort{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(required, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//PushNotificationAbort:users.messages.pushnotification.Abort{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//PushNotificationAbort:users.messages.pushnotification.Abort{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//PushNotificationAbort:users.messages.pushnotification.Abort{"context":{"traits":{},"device":{"type":"(required, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(required, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de mensagens de aborto de SMS
Esse evento ocorre se uma mensagem SMS foi abortada com base em Liquid aborts, Horário de silêncio, etc.
//SMSAbort:users.messages.sms.Abort{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//SMSAbort:users.messages.sms.Abort{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SMSAbort:users.messages.sms.Abort{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSAbort:users.messages.sms.Abort{"event_properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSAbort:users.messages.sms.Abort{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de mensagens de abortamento de webhook
Esse evento ocorre se uma mensagem de webhook foi abortada com base em Liquid aborts ou Horário de silêncio.
//WebhookAbort:users.messages.webhook.Abort{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//WebhookAbort:users.messages.webhook.Abort{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WebhookAbort:users.messages.webhook.Abort{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WebhookAbort:users.messages.webhook.Abort{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WebhookAbort:users.messages.webhook.Abort{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"abort_log":"(optional, string) Log message describing abort details (up to 128 chars)","abort_type":"(optional, string) Type of abort","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de saída da tela realizados
Esse evento ocorre quando um usuário sai de um Canva ao executar um evento.
//ExitPerformEvent:users.canvas.exit.PerformedEvent{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//ExitPerformEvent:users.canvas.exit.PerformedEvent{"app_group_api_id":"(optional, string) [DEPRECATED]","app_group_id":"(required, string) API ID of the app group this user belongs to","canvas_api_id":"(optional, string) [DEPRECATED]","canvas_id":"(required, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_api_id":"(optional, string) [DEPRECATED]","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_api_id":"(optional, string) [DEPRECATED]","canvas_variation_id":"(required, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ExitPerformEvent:users.canvas.exit.PerformedEvent{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//ExitPerformEvent:users.canvas.exit.PerformedEvent{"event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ExitPerformEvent:users.canvas.exit.PerformedEvent{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de público correspondentes à saída do Canva
Esse evento ocorre quando um usuário sai de um Canva ao corresponder a um público.
//ExitMatchAudience:users.canvas.exit.MatchedAudience{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//ExitMatchAudience:users.canvas.exit.MatchedAudience{"app_group_api_id":"(optional, string) [DEPRECATED]","app_group_id":"(required, string) API ID of the app group this user belongs to","canvas_api_id":"(optional, string) [DEPRECATED]","canvas_id":"(required, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_api_id":"(optional, string) [DEPRECATED]","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_api_id":"(optional, string) [DEPRECATED]","canvas_variation_id":"(required, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ExitMatchAudience:users.canvas.exit.MatchedAudience{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//ExitMatchAudience:users.canvas.exit.MatchedAudience{"event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ExitMatchAudience:users.canvas.exit.MatchedAudience{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Experimente eventos de entrada dividida
Esse evento ocorre quando um usuário entra em uma etapa do experimento do Canva.
//ExperimentSplitEntry:users.canvas.experimentstep.SplitEntry{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","in_control_group":"(required, boolean) Whether the user was enrolled in the control group","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//ExperimentSplitEntry:users.canvas.experimentstep.SplitEntry{"canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","in_control_group":"(required, boolean) Whether the user was enrolled in the control group","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ExperimentSplitEntry:users.canvas.experimentstep.SplitEntry{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","in_control_group":"(required, boolean) Whether the user was enrolled in the control group"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ExperimentSplitEntry:users.canvas.experimentstep.SplitEntry{"event_properties":{"canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","in_control_group":"(required, boolean) Whether the user was enrolled in the control group"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ExperimentSplitEntry:users.canvas.experimentstep.SplitEntry{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","in_control_group":"(required, boolean) Whether the user was enrolled in the control group"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de conversão de experimentos
Esse evento ocorre quando um usuário converte para uma etapa do experimento do Canva.
//ExperimentStepConversion:users.canvas.experimentstep.Conversion{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//ExperimentStepConversion:users.canvas.experimentstep.Conversion{"app_id":"(optional, string) API ID of the app on which this event occurred","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ExperimentStepConversion:users.canvas.experimentstep.Conversion{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ExperimentStepConversion:users.canvas.experimentstep.Conversion{"event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ExperimentStepConversion:users.canvas.experimentstep.Conversion{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","experiment_split_id":"(optional, string) API ID of the experiment split the user enrolled in","experiment_split_name":"(optional, string) Name of the experiment split","experiment_step_id":"(optional, string) API ID of the experiment step this event belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de envio por push
Esse evento ocorre quando a Braze processa uma mensagem push para um usuário, comunicando-a ao Serviço de Notificações por Push da Apple ou ao Fire Cloud Messaging. Isso não significa que o push foi entregue ao dispositivo, apenas que uma mensagem foi enviada.
//PushNotificationSend:users.messages.pushnotification.Send{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//PushNotificationSend:users.messages.pushnotification.Send{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(required, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//PushNotificationSend:users.messages.pushnotification.Send{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//PushNotificationSend:users.messages.pushnotification.Send{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//PushNotificationSend:users.messages.pushnotification.Send{"context":{"traits":{},"device":{"type":"(required, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(required, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.
Eventos de abertura por push
Esse evento ocorre quando um usuário clica diretamente na notificação por push para abrir o aplicativo. Atualmente, os eventos Push Open referem-se especificamente a “aberturas diretas” em vez de “aberturas totais”. Isso não inclui estatísticas mostradas no nível da campanha de “aberturas por influência”, pois elas não são atribuídas no nível do usuário.
//PushNotificationOpen:users.messages.pushnotification.Open{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//PushNotificationOpen:users.messages.pushnotification.Open{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","button_action_type":"(optional, string) Action type of the push notification button, null if not from a button click. One of ['uri', 'deep_link', 'none', 'close']","button_string":"(optional, string) Identifier (button_string) of the push notification button clicked. null if not from a button click","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//PushNotificationOpen:users.messages.pushnotification.Open{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//PushNotificationOpen:users.messages.pushnotification.Open{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//PushNotificationOpen:users.messages.pushnotification.Open{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Notificações por push nos eventos em primeiro plano do iOS
Esse evento não é compatível com nosso Swift SDK e agora está obsoleto em nosso Obj-C SDK .
//PushNotificationiOSForegroundOpen:users.messages.pushnotification.IosForeground{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//PushNotificationiOSForegroundOpen:users.messages.pushnotification.IosForeground{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(required, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//PushNotificationiOSForegroundOpen:users.messages.pushnotification.IosForeground{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//PushNotificationiOSForegroundOpen:users.messages.pushnotification.IosForeground{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Notificações por push bounce
Esse evento ocorre quando um erro é recebido do serviço de Notificações por Push da Apple ou do Fire Cloud Messaging. Isso significa que a mensagem push sofreu bounce e, portanto, não foi entregue ao dispositivo do usuário.
//PushNotificationBounce:users.messages.pushnotification.Bounce{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//PushNotificationBounce:users.messages.pushnotification.Bounce{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//PushNotificationBounce:users.messages.pushnotification.Bounce{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//PushNotificationBounce:users.messages.pushnotification.Bounce{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//PushNotificationBounce:users.messages.pushnotification.Bounce{"context":{"traits":{},"device":{"type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com seu gerente de sucesso do cliente ou gerente de conta para ativar o flipper de recursos para enviar ad_id.
Eventos de envio de e-mail
Esse evento ocorre quando uma solicitação de envio de e-mail foi comunicada com êxito entre o Braze e o SendGrid. No entanto, isso não significa que o e-mail foi recebido na caixa de entrada do usuário final.
//EmailSend:users.messages.email.Send{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//EmailSend:users.messages.email.Send{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailSend:users.messages.email.Send{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailSend:users.messages.email.Send{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","ip_pool":"(optional, string) IP pool from which the email send was made","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailSend:users.messages.email.Send{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.
Eventos de envio de e-mail
Esse evento ocorre quando um e-mail enviado chega com êxito à caixa de entrada do usuário final.
//EmailDelivery:users.messages.email.Delivery{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","distinct_id":"(required, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//EmailDelivery:users.messages.email.Delivery{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","external_user_id":"(optional, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","sending_ip":"(optional, string) IP address from which the email send was made","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailDelivery:users.messages.email.Delivery{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailDelivery:users.messages.email.Delivery{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailDelivery:users.messages.email.Delivery{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Eventos abertos por e-mail
Esse evento ocorre quando um usuário abre um e-mail. Vários eventos podem ser gerados para a mesma campanha se um usuário abrir o e-mail várias vezes.
important:
É um comportamento conhecido o fato de os campos de evento de abertura de e-mail device_model e mailbox_provider estarem vazios. Você pode ignorá-los por enquanto.
//EmailOpen:users.messages.email.Open{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","distinct_id":"(required, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","machine_open":"(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token","user_agent":"(optional, string) User agent on which the spam report occurred"}}
//EmailOpen:users.messages.email.Open{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_model":"(optional, string) Model of the device","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","external_user_id":"(optional, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","machine_open":"(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_agent":"(optional, string) User agent on which the spam report occurred","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailOpen:users.messages.email.Open{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_id":"(optional, string) ID of the device on which the event occurred","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","machine_open":"(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","user_agent":"(optional, string) User agent on which the spam report occurred"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailOpen:users.messages.email.Open{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_model":"(optional, string) Model of the device","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","machine_open":"(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","user_agent":"(optional, string) User agent on which the spam report occurred"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailOpen:users.messages.email.Open{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{"model":"(optional, string) Model of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_id":"(optional, string) ID of the device on which the event occurred","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","machine_open":"(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","user_agent":"(optional, string) User agent on which the spam report occurred"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Eventos de cliques de e-mail
Esse evento ocorre quando um usuário clica em um e-mail. Vários eventos podem ser gerados para a mesma campanha se um usuário clicar várias vezes ou clicar em diferentes links dentro do e-mail.
//EmailClick:users.messages.email.Click{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","distinct_id":"(required, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","link_alias":"(optional, string) Alias associated with this link ID","link_id":"(optional, string) Unique ID for the link which was clicked, as created by Braze","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred"}}
//EmailClick:users.messages.email.Click{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_model":"(optional, string) Model of the device","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","external_user_id":"(optional, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","link_alias":"(optional, string) Alias associated with this link ID","link_id":"(optional, string) Unique ID for the link which was clicked, as created by Braze","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailClick:users.messages.email.Click{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_id":"(optional, string) ID of the device on which the event occurred","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","link_alias":"(optional, string) Alias associated with this link ID","link_id":"(optional, string) Unique ID for the link which was clicked, as created by Braze","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailClick:users.messages.email.Click{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_model":"(optional, string) Model of the device","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","link_alias":"(optional, string) Alias associated with this link ID","link_id":"(optional, string) Unique ID for the link which was clicked, as created by Braze","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailClick:users.messages.email.Click{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{"model":"(optional, string) Model of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_class":"(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)","device_id":"(optional, string) ID of the device on which the event occurred","device_os":"(optional, string) Device operating system extracted from user_agent","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_amp":"(optional, boolean) Indicates that this is an AMP event","link_alias":"(optional, string) Alias associated with this link ID","link_id":"(optional, string) Unique ID for the link which was clicked, as created by Braze","mailbox_provider":"(optional, string) Mailbox provider value returned by the esp for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","url":"(optional, string) URL that the user clicked on","link_url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Evento de bounce de e-mail
Esse evento ocorre quando um provedor de serviços de Internet retorna um hard bounce. Um hard bounce significa uma falha permanente de entregabilidade.
//EmailBounce:users.messages.email.Bounce{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","distinct_id":"(required, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","is_drop":"(optional, boolean) Indicates that this event counts as a drop event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//EmailBounce:users.messages.email.Bounce{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","external_user_id":"(optional, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","is_drop":"(optional, boolean) Indicates that this event counts as a drop event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","sending_ip":"(optional, string) IP address from which the email send was made","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailBounce:users.messages.email.Bounce{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_drop":"(optional, boolean) Indicates that this event counts as a drop event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailBounce:users.messages.email.Bounce{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_drop":"(optional, boolean) Indicates that this event counts as a drop event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailBounce:users.messages.email.Bounce{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","is_drop":"(optional, boolean) Indicates that this event counts as a drop event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Evento de soft bounce de e-mail
Esse evento ocorre quando um prestador de serviço de Internet retorna um soft bounce. Um soft bounce significa que um e-mail não pôde ser entregue devido a uma falha temporária de entregabilidade.
//EmailSoftBounce:users.messages.email.SoftBounce{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","distinct_id":"(required, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//EmailSoftBounce:users.messages.email.SoftBounce{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","external_user_id":"(optional, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","sending_ip":"(optional, string) IP address from which the email send was made","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailSoftBounce:users.messages.email.SoftBounce{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailSoftBounce:users.messages.email.SoftBounce{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailSoftBounce:users.messages.email.SoftBounce{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","bounce_reason":"(optional, string) The SMTP reason code and user friendly message received for this bounce event","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Eventos de spam de e-mail
Esse evento ocorre quando o usuário final pressiona o botão “spam” no e-mail. Observe que isso não representa o fato de o e-mail ter ido para a pasta de spam, pois o Braze não faz esse rastreamento.
//EmailMarkAsSpam:users.messages.email.MarkAsSpam{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","distinct_id":"(required, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token","user_agent":"(optional, string) User agent on which the spam report occurred"}}
//EmailMarkAsSpam:users.messages.email.MarkAsSpam{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","external_user_id":"(optional, string) External ID of the user","from_domain":"(optional, string) Sending domain for the email","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_agent":"(optional, string) User agent on which the spam report occurred","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailMarkAsSpam:users.messages.email.MarkAsSpam{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","user_agent":"(optional, string) User agent on which the spam report occurred"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailMarkAsSpam:users.messages.email.MarkAsSpam{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","user_agent":"(optional, string) User agent on which the spam report occurred"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailMarkAsSpam:users.messages.email.MarkAsSpam{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","esp":"(optional, string) ESP related to the event (Sparkpost or Sendgrid)","from_domain":"(optional, string) Sending domain for the email","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","user_agent":"(optional, string) User agent on which the spam report occurred"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Eventos de cancelamento de inscrição de e-mail
Esse evento ocorre quando o usuário final clica em “cancelar inscrição” no e-mail.
important:
O evento Unsubscribe é, na verdade, um evento de clique especializado que é disparado quando o usuário clica no ink de cancelamento de inscrição no e-mail (seja um link normal de cancelamento de inscrição no corpo ou no rodapé do e-mail, seja usando o cabeçalho list-unsubscribe), e não quando o usuário muda o estado para unsubscribed. Se a alteração do estado da inscrição for enviada por meio da API ou por meio de um link de cancelamento de inscrição personalizado (não Braze), ela não disparará um evento no Currents.
//EmailUnsubscribe:users.messages.email.Unsubscribe{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//EmailUnsubscribe:users.messages.email.Unsubscribe{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//EmailUnsubscribe:users.messages.email.Unsubscribe{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(required, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//EmailUnsubscribe:users.messages.email.Unsubscribe{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","email_address":"(required, string) Email address of the user","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//EmailUnsubscribe:users.messages.email.Unsubscribe{"context":{"traits":{"email":"(required, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","ip_pool":"(optional, string) IP pool from which the email send was made","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
O comportamento do site dispatch_id difere entre o canva e as campanhas porque a Braze trata as etapas do canva (exceto as etapas de entrada, que podem ser programadas) como eventos disparados, mesmo quando estão programadas. Saiba mais sobre o comportamento do ID de despacho.
Eventos de impressão de mensagens no app
Esse evento ocorre quando um usuário visualiza uma mensagem no app.
//In-AppMessageImpression:users.messages.inappmessage.Impression{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"null","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//In-AppMessageImpression:users.messages.inappmessage.Impression{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","dispatch_id":"null","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//In-AppMessageImpression:users.messages.inappmessage.Impression{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"null","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//In-AppMessageImpression:users.messages.inappmessage.Impression{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_model":"(optional, string) Model of the device","dispatch_id":"null","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//In-AppMessageImpression:users.messages.inappmessage.Impression{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"null","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
note:
O campo message_extras estará ativo em 4 de abril de 2024.
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Eventos de clique de mensagem no app
Esse evento ocorre quando um usuário clica em uma mensagem no app.
//In-AppMessageClick:users.messages.inappmessage.Click{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","button_id":"(optional, string) ID of the button clicked, if this click represents a click on a button","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"null","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//In-AppMessageClick:users.messages.inappmessage.Click{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","button_id":"(optional, string) ID of the button clicked, if this click represents a click on a button","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","dispatch_id":"null","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//In-AppMessageClick:users.messages.inappmessage.Click{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","button_id":"(optional, string) ID of the button clicked, if this click represents a click on a button","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"null","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//In-AppMessageClick:users.messages.inappmessage.Click{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","button_id":"(optional, string) ID of the button clicked, if this click represents a click on a button","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_model":"(optional, string) Model of the device","dispatch_id":"null","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//In-AppMessageClick:users.messages.inappmessage.Click{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","button_id":"(optional, string) ID of the button clicked, if this click represents a click on a button","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(optional, string) API ID of the card","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"null","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Eventos de envio de webhooks
Esse evento ocorre quando um webhook foi processado e enviado para o terceiro especificado nesse webhook. Observe que isso não significa que a solicitação foi recebida ou não.
//WebhookSend:users.messages.webhook.Send{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//WebhookSend:users.messages.webhook.Send{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//WebhookSend:users.messages.webhook.Send{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//WebhookSend:users.messages.webhook.Send{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//WebhookSend:users.messages.webhook.Send{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.
Eventos de envio do cartão de conteúdo
Esse evento ocorre quando um cartão de conteúdo é enviado a um usuário.
//ContentCardSend:users.messages.contentcard.Send{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//ContentCardSend:users.messages.contentcard.Send{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","content_card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ContentCardSend:users.messages.contentcard.Send{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ContentCardSend:users.messages.contentcard.Send{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ContentCardSend:users.messages.contentcard.Send{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.
Eventos de impressão do cartão de conteúdo
Esse evento ocorre quando um usuário visualiza um cartão de conteúdo.
//ContentCardImpression:users.messages.contentcard.Impression{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//ContentCardImpression:users.messages.contentcard.Impression{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","content_card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ContentCardImpression:users.messages.contentcard.Impression{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ContentCardImpression:users.messages.contentcard.Impression{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ContentCardImpression:users.messages.contentcard.Impression{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Eventos de clique do cartão de conteúdo
Esse evento ocorre quando um usuário clica em um cartão de conteúdo.
//ContentCardClick:users.messages.contentcard.Click{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//ContentCardClick:users.messages.contentcard.Click{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","content_card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ContentCardClick:users.messages.contentcard.Click{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ContentCardClick:users.messages.contentcard.Click{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ContentCardClick:users.messages.contentcard.Click{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Eventos de descarte de cartão de conteúdo
Esse evento ocorre quando um usuário descarta um cartão de conteúdo.
//ContentCardDismiss:users.messages.contentcard.Dismiss{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//ContentCardDismiss:users.messages.contentcard.Dismiss{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","content_card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//ContentCardDismiss:users.messages.contentcard.Dismiss{"device_info":{"ios_advertising_id":"(optional, string) Advertising identifier","android_advertising_id":"(optional, string) Advertising identifier","microsoft_advertising_id":"(optional, string) Advertising identifier","roku_advertising_id":"(optional, string) Advertising identifier","limit_ad_tracking":"(optional, boolean) Whether advertising tracking is enabled for the device","ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//ContentCardDismiss:users.messages.contentcard.Dismiss{"adid":"(optional, string) Advertising identifier","device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_model":"(optional, string) Model of the device","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","idfa":"(optional, string) Advertising identifier","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//ContentCardDismiss:users.messages.contentcard.Dismiss{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"ad_id":"(optional, string) Advertising identifier","ad_id_type":"(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']","ad_tracking_enabled":"(optional, boolean) Whether advertising tracking is enabled for the device","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","card_id":"(required, string) ID of the card that generated this event","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
Para ad_id, ad_id_type e ad_tracking_enabled, você precisa coletar explicitamente o IDFA do iOS e o ID de publicidade do Google do Android por meio dos SDKs nativos. Saiba mais sobre essa configuração para iOS e Android.
Se estiver usando o Kafka para ingerir dados do Currents, entre em contato com o gerente de sucesso do cliente para ativar o envio de ad_id.
Eventos de clique do SMS
Esse evento ocorre quando um usuário clica em um link curto de SMS.
//SMSShortLinkClick:users.messages.sms.ShortLinkClick{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","short_url":"(required, string) Shortened url that was clicked","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred","user_phone_number":"(optional, string) The user's phone number from which the message was received"}}
//SMSShortLinkClick:users.messages.sms.ShortLinkClick{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","short_url":"(required, string) Shortened url that was clicked","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","url":"(required, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred","user_id":"(required, string) Braze user ID of the user who performed this event","user_phone_number":"(optional, string) The user's phone number from which the message was received"}
//SMSShortLinkClick:users.messages.sms.ShortLinkClick{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","short_url":"(required, string) Shortened url that was clicked","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) The user's phone number from which the message was received"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSShortLinkClick:users.messages.sms.ShortLinkClick{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","short_url":"(required, string) Shortened url that was clicked","url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred","user_phone_number":"(optional, string) The user's phone number from which the message was received"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSShortLinkClick:users.messages.sms.ShortLinkClick{"context":{"traits":{"phone":"(optional, string) The user's phone number from which the message was received"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","short_url":"(required, string) Shortened url that was clicked","url":"(optional, string) URL that the user clicked on","link_url":"(optional, string) URL that the user clicked on","user_agent":"(optional, string) User agent on which the spam report occurred"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de envio de SMS
Esse evento ocorre quando um usuário envia um SMS.
//SMSSend:users.messages.sms.Send{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","category":"(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//SMSSend:users.messages.sms.Send{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","category":"(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SMSSend:users.messages.sms.Send{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","category":"(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSSend:users.messages.sms.Send{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","category":"(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSSend:users.messages.sms.Send{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","category":"(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_extras":"(optional, string) A JSON string of the tagged key-value pairs during liquid rendering","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
message_extras permite que você anote seus eventos de envio com dados dinâmicos do conteúdo conectado, atributos personalizados (como idioma, país) e propriedades de entrada nos canvas. Consulte Envio de mensagens extras para saber mais.
Envio de SMS para eventos da operadora
important:
CarrierSend é suportado apenas para usuários em infraestrutura legada.
Esse evento ocorre quando um SMS é enviado à operadora.
//SMSCarrierSend:users.messages.sms.CarrierSend{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//SMSCarrierSend:users.messages.sms.CarrierSend{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SMSCarrierSend:users.messages.sms.CarrierSend{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSCarrierSend:users.messages.sms.CarrierSend{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSCarrierSend:users.messages.sms.CarrierSend{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de entrega de SMS
Esse evento ocorre quando um SMS é entregue com êxito ao telefone celular do usuário.
//SMSDelivery:users.messages.sms.Delivery{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//SMSDelivery:users.messages.sms.Delivery{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SMSDelivery:users.messages.sms.Delivery{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSDelivery:users.messages.sms.Delivery{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSDelivery:users.messages.sms.Delivery{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de rejeição de SMS
Esse evento ocorre quando um envio de SMS é rejeitado pela operadora, o que pode ocorrer por vários motivos. Use esse evento e os códigos de erro fornecidos para ajudar a solucionar problemas com a entrega de SMS.
//SMSRejection:users.messages.sms.Rejection{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","distinct_id":"(required, string) External ID of the user","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//SMSRejection:users.messages.sms.Rejection{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","external_user_id":"(optional, string) External ID of the user","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SMSRejection:users.messages.sms.Rejection{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSRejection:users.messages.sms.Rejection{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSRejection:users.messages.sms.Rejection{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","from_phone_number":"(optional, string) Phone number used to send in e.164 format (for example +14155552671)","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de falha na entrega de SMS
Esse evento ocorre quando um SMS apresenta falha na entrega. Use esse evento e os códigos de erro fornecidos para ajudar a solucionar problemas com a entrega de SMS.
//SMSDeliveryFailure:users.messages.sms.DeliveryFailure{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","token":"(required, string) The Mixpanel API token"}}
//SMSDeliveryFailure:users.messages.sms.DeliveryFailure{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SMSDeliveryFailure:users.messages.sms.DeliveryFailure{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSDeliveryFailure:users.messages.sms.DeliveryFailure{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID","to_phone_number":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSDeliveryFailure:users.messages.sms.DeliveryFailure{"context":{"traits":{"phone":"(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","error":"(optional, string) Error name","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","provider_error_code":"(optional, string) Error code from the SMS provider","send_id":"(optional, string) Message send ID this message belongs to","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de entrada de SMS recebidos
Esse evento ocorre quando um dos seus usuários envia um SMS para um número de telefone em um dos seus grupos de inscrições do Braze SMS.
Quando o Braze recebe um SMS de entrada, atribuímos essa mensagem de entrada a qualquer usuário que compartilhe esse número de telefone. Como resultado, você poderá receber vários eventos por mensagem recebida se vários usuários na sua instância do Braze compartilharem o mesmo número de telefone. Se for necessária a atribuição de IDs de usuários específicos com base em mensagens anteriores enviadas a esse usuário, é possível usar o evento SMS Delivered para atribuir eventos Inbound Received ao ID do usuário que recebeu mais recentemente uma mensagem do seu número Braze.
Se detectarmos que essa mensagem de entrada é uma resposta a uma campanha de saída ou a um componente do Canvas enviado pelo Braze, também incluiremos os metadados da campanha ou do Canvas no evento. O Braze define uma resposta como uma mensagem recebida dentro de quatro horas após uma mensagem enviada. No entanto, há um cache de um minuto para as informações da campanha de atribuição do último SMS de saída recebido.
//SMSInboundReceived:users.messages.sms.InboundReceive{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token","user_phone_number":"(required, string) The user's phone number from which the message was received"}}
//SMSInboundReceived:users.messages.sms.InboundReceive{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(required, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(required, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) BSON ID of subscription group","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) Braze user ID of the user who performed this event","user_phone_number":"(required, string) The user's phone number from which the message was received"}
//SMSInboundReceived:users.messages.sms.InboundReceive{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","inbound_phone_number":"(required, string) The inbound number that the message was sent to","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{"$mobile":"(required, string) The user's phone number from which the message was received"},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//SMSInboundReceived:users.messages.sms.InboundReceive{"event_properties":{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID","user_phone_number":"(required, string) The user's phone number from which the message was received"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SMSInboundReceived:users.messages.sms.InboundReceive{"context":{"traits":{"phone":"(required, string) The user's phone number from which the message was received"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"action":"(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","inbound_phone_number":"(required, string) The inbound number that the message was sent to","media_urls":"(optional, array of string) Media URLs from the user","message_body":"(optional, string) Typed response from the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","subscription_group_id":"(optional, string) Subscription group API ID"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de impressão de feature flags
Esse evento ocorre sempre que um usuário tem a oportunidade de interagir com o seu recurso ou quando ele poderia ter interagido se o recurso estivesse desativado (no caso de um grupo de controle em um Testes A/B).
As impressões do Feature Flag são registradas apenas uma vez por sessão.
//FeatureFlagExperimentImpression:users.messages.featureflag.Impression{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","$device":"(optional, string) Model of the device","distinct_id":"(required, string) External ID of the user","feature_flag_id_name":"(optional, string) The Feature Flag Rollout identifier","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","$os":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//FeatureFlagExperimentImpression:users.messages.featureflag.Impression{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_message_variation_id":"(optional, string) API ID of the Canvas step message variation this user received","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","carrier":"(optional, string) Carrier of the device","country":"(optional, string) Country of the user","device_id":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","external_user_id":"(optional, string) External ID of the user","feature_flag_id_name":"(optional, string) The Feature Flag Rollout identifier","gender":"(optional, string) Gender of the user, one of ['M', 'F', 'O', 'N', 'P']","id":"(required, string) Globally unique ID for this event","language":"(optional, string) Language of the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","resolution":"(optional, string) Resolution of the device","sdk_version":"(optional, string) Version of the Braze SDK in use during the event","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//FeatureFlagExperimentImpression:users.messages.featureflag.Impression{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred","device_model":"(optional, string) Model of the device","platform":"(optional, string) Platform of the device"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","feature_flag_id_name":"(optional, string) The Feature Flag Rollout identifier","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//FeatureFlagExperimentImpression:users.messages.featureflag.Impression{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_model":"(optional, string) Model of the device","feature_flag_id_name":"(optional, string) The Feature Flag Rollout identifier","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","os_version":"(optional, string) Version of the operating system of the device","platform":"(optional, string) Platform of the device","timezone":"(optional, string) Time zone of the user"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//FeatureFlagExperimentImpression:users.messages.featureflag.Impression{"context":{"traits":{},"device":{"model":"(optional, string) Model of the device","type":"(optional, string) Platform of the device"}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","browser":"(optional, string) Device browser - extracted from user_agent - on which the open occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","feature_flag_id_name":"(optional, string) The Feature Flag Rollout identifier","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","platform":"(optional, string) Platform of the device"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de conversão de campanha
Esse evento ocorre quando um usuário realiza uma ação que foi definida como um evento de conversão em uma campanha.
important:
Note que o evento de conversão é codificado no campo conversion_behavior, que inclui o tipo de evento de conversão, a janela (período) e informações adicionais, dependendo do tipo de evento de conversão. O campo conversion_behavior_index representa qual evento de conversão, como 0 = A, 1 = B, 2 = C, 3 = D.
//CampaignConversion:users.campaigns.Conversion{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//CampaignConversion:users.campaigns.Conversion{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","campaign_id":"(required, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//CampaignConversion:users.campaigns.Conversion{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//CampaignConversion:users.campaigns.Conversion{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//CampaignConversion:users.campaigns.Conversion{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de conversão do Canva
Esse evento ocorre quando um usuário executa uma ação que foi definida como um evento de conversão no Canva.
important:
Note que o evento de conversão é codificado no campo conversion_behavior, que inclui o tipo de evento de conversão, a janela (período) e informações adicionais, dependendo do tipo de evento de conversão. O campo conversion_behavior_index representa qual evento de conversão, como 0 = A, 1 = B, 2 = C, 3 = D.
//CanvasConversion:users.canvas.Conversion{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","device_id":"(optional, string) ID of the device on which the event occurred","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//CanvasConversion:users.canvas.Conversion{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","canvas_id":"(required, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(required, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//CanvasConversion:users.canvas.Conversion{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","device_id":"(optional, string) ID of the device on which the event occurred"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//CanvasConversion:users.canvas.Conversion{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//CanvasConversion:users.canvas.Conversion{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","conversion_behavior":"(optional, string) JSON-encoded string describing the conversion behavior","conversion_behavior_index":"(optional, int) Index of the conversion behavior","device_id":"(optional, string) ID of the device on which the event occurred"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de entrada na tela
Esse evento ocorre quando um usuário entra no Canva. Esse evento informa em qual variante o usuário entrou.
//CanvasEntry:users.canvas.Entry{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","in_control_group":"(required, boolean) Whether the user was enrolled in the control group","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
//CanvasEntry:users.canvas.Entry{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(required, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(required, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","in_control_group":"(required, boolean) Whether the user was enrolled in the control group","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//CanvasEntry:users.canvas.Entry{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","in_control_group":"(required, boolean) Whether the user was enrolled in the control group"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//CanvasEntry:users.canvas.Entry{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","in_control_group":"(required, boolean) Whether the user was enrolled in the control group"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//CanvasEntry:users.canvas.Entry{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","in_control_group":"(required, boolean) Whether the user was enrolled in the control group"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de progressão de etapas do canva
Esse evento ocorre quando um usuário avança em uma etapa do Canva com algum resultado. Note que esse evento não ocorre quando as etapas são inseridas ou encerradas. Atualmente, apenas as etapas divididas (jornadas do público, divisão de decisão, jornadas de ação, experimento) e os resultados avançados geram eventos de progressão de etapas.
//CanvasStepProgression:users.canvasstep.Progression{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_entry_id":"(required, string) Unique identifier for this instance of a user in a canvas","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","exit_reason":"(optional, string) If this is an exit, the reason a user exited the canvas during the step","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","is_canvas_entry":"(optional, boolean) Whether this is entry into a first step in a canvas","next_step_id":"(optional, string) API ID of the next step in the canvas","progression_type":"(required, string) What type of step progression event this is","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//CanvasStepProgression:users.canvasstep.Progression{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_entry_id":"(required, string) Unique identifier for this instance of a user in a canvas","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","exit_reason":"(optional, string) If this is an exit, the reason a user exited the canvas during the step","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","is_canvas_entry":"(optional, boolean) Whether this is entry into a first step in a canvas","next_step_id":"(optional, string) API ID of the next step in the canvas","progression_type":"(required, string) What type of step progression event this is","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//CanvasStepProgression:users.canvasstep.Progression{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_entry_id":"(required, string) Unique identifier for this instance of a user in a canvas","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","exit_reason":"(optional, string) If this is an exit, the reason a user exited the canvas during the step","is_canvas_entry":"(optional, boolean) Whether this is entry into a first step in a canvas","next_step_id":"(optional, string) API ID of the next step in the canvas","progression_type":"(required, string) What type of step progression event this is"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//CanvasStepProgression:users.canvasstep.Progression{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_entry_id":"(required, string) Unique identifier for this instance of a user in a canvas","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","exit_reason":"(optional, string) If this is an exit, the reason a user exited the canvas during the step","is_canvas_entry":"(optional, boolean) Whether this is entry into a first step in a canvas","next_step_id":"(optional, string) API ID of the next step in the canvas","progression_type":"(required, string) What type of step progression event this is"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//CanvasStepProgression:users.canvasstep.Progression{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_entry_id":"(required, string) Unique identifier for this instance of a user in a canvas","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","exit_reason":"(optional, string) If this is an exit, the reason a user exited the canvas during the step","is_canvas_entry":"(optional, boolean) Whether this is entry into a first step in a canvas","next_step_id":"(optional, string) API ID of the next step in the canvas","progression_type":"(required, string) What type of step progression event this is"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de inscrição no grupo de controle da campanha
Esse evento ocorre quando um usuário é inscrito em um conjunto de variantes de controle em uma campanha com várias variantes. Esse evento é gerado porque não haverá nenhum evento de envio de canal para esse usuário.
//CampaignControlGroupEnrollment:users.campaigns.EnrollInControl{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
//CampaignControlGroupEnrollment:users.campaigns.EnrollInControl{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","campaign_id":"(required, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//CampaignControlGroupEnrollment:users.campaigns.EnrollInControl{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
//CampaignControlGroupEnrollment:users.campaigns.EnrollInControl{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//CampaignControlGroupEnrollment:users.campaigns.EnrollInControl{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","device_id":"(optional, string) ID of the device on which the event occurred","dispatch_id":"(optional, string) ID of the dispatch this message belongs to","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Eventos de inscrição
Esse evento ocorre quando o estado da inscrição de um usuário em um grupo de inscrições é alterado.
important:
No momento, os grupos de inscrições estão disponíveis apenas para os canais de e-mail, SMS e WhatsApp.
//SubscriptionGroupStateChange:users.behaviors.subscriptiongroup.StateChange{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","email_address":"(optional, string) Email address of the user","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_group_id":"(required, string) Subscription group API ID","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//SubscriptionGroupStateChange:users.behaviors.subscriptiongroup.StateChange{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","channel":"(optional, string) Channel this event belongs to","email_address":"(optional, string) Email address of the user","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","phone_number":"(optional, string) Phone number of the user in e.164 format (for example +14155552671)","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_group_id":"(required, string) Subscription group API ID","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//SubscriptionGroupStateChange:users.behaviors.subscriptiongroup.StateChange{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_group_id":"(required, string) Subscription group API ID","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(optional, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//SubscriptionGroupStateChange:users.behaviors.subscriptiongroup.StateChange{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","email_address":"(optional, string) Email address of the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_group_id":"(required, string) Subscription group API ID","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'","timezone":"(optional, string) Time zone of the user"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//SubscriptionGroupStateChange:users.behaviors.subscriptiongroup.StateChange{"context":{"traits":{"email":"(optional, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","device_id":"(optional, string) ID of the device on which the event occurred","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_group_id":"(required, string) Subscription group API ID","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
state_change_source retornará uma string com o nome completo da fonte. Por exemplo, a importação do CSV de origem retornará a string CSV Import. As fontes disponíveis estão listadas abaixo:
Origem
Descrição
SDK
Endpoints de SDK
Dashboard
Quando o estado da inscrição de um usuário é atualizado na página Perfil do usuário no dashboard
Página de inscrição
Quando um usuário cancela a inscrição por meio de um link de cancelamento de inscrição por e-mail que não seja a Central de Preferências
API REST
Pontos de extremidade da API REST
Importação de CSV
Importação de usuário CSV
Central de Preferências
Quando um usuário é atualizado a partir da Central de Preferências
Mensagem recebida
Quando um usuário é atualizado por mensagens recebidas de usuários finais por meio de canais como SMS
Migração
Quando um usuário é atualizado por migrações internas ou scripts de manutenção
Mesclagem de usuários
Quando um usuário é atualizado pelo processo de mesclagem de usuários
Etapa de atualização do usuário do canva
Quando um usuário é atualizado pela etapa de atualização do usuário do Canva
Eventos de mudança de estado global
Esse evento ocorre quando o Braze recebe uma solicitação para atualizar o estado de inscrição global do usuário, mesmo que a solicitação não altere o estado de inscrição atual do usuário.
//GlobalSubscriptionStateChange:users.behaviors.subscription.GlobalStateChange{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","email_address":"(optional, string) Email address of the user","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
//GlobalSubscriptionStateChange:users.behaviors.subscription.GlobalStateChange{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(optional, string) API ID of the app on which this event occurred","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","channel":"(optional, string) Channel this event belongs to","email_address":"(optional, string) Email address of the user","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","message_variation_id":"(optional, string) API ID of the message variation this user received","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'","time":"(required, int) UNIX timestamp at which the event happened","timezone":"(optional, string) Time zone of the user","user_id":"(required, string) Braze user ID of the user who performed this event"}
//GlobalSubscriptionStateChange:users.behaviors.subscription.GlobalStateChange{"device_info":{},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'"},"custom_event_type":"(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')","event_name":"(required, string) The event type name, as it is exported to mParticle","source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"email":"(optional, string) Email address of the user","customerid":"(required, string) External ID of the user"}}
//GlobalSubscriptionStateChange:users.behaviors.subscription.GlobalStateChange{"event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","email_address":"(optional, string) Email address of the user","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'","timezone":"(optional, string) Time zone of the user"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
//GlobalSubscriptionStateChange:users.behaviors.subscription.GlobalStateChange{"context":{"traits":{"email":"(optional, string) Email address of the user"},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","campaign_id":"(optional, string) API ID of the campaign this event belongs to","campaign_name":"(optional, string) Name of the campaign","canvas_id":"(optional, string) API ID of the Canvas this event belongs to","canvas_name":"(optional, string) Name of the Canvas","canvas_step_id":"(optional, string) API ID of the Canvas step this event belongs to","canvas_step_name":"(optional, string) Name of the Canvas step","canvas_variation_id":"(optional, string) API ID of the Canvas variation this event belongs to","canvas_variation_name":"(optional, string) Name of the Canvas variation this user received","message_variation_id":"(optional, string) API ID of the message variation this user received","message_variation_name":"(optional, string) Name of the message variation","send_id":"(optional, string) Message send ID this message belongs to","state_change_source":"(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.","subscription_status":"(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Detalhes da propriedade
state_change_source retornará uma string com o nome completo da fonte. Por exemplo, a importação do CSV de origem retornará a string CSV Import. As fontes disponíveis estão listadas abaixo:
Origem
Descrição
SDK
Endpoints de SDK
Dashboard
Quando o estado da inscrição de um usuário é atualizado na página Perfil do usuário no dashboard
Página de inscrição
Quando um usuário cancela a inscrição por meio de um link de cancelamento de inscrição por e-mail que não seja a Central de Preferências
API REST
Pontos de extremidade da API REST
Importação de CSV
Importação de usuário CSV
Central de Preferências
Quando um usuário é atualizado a partir da Central de Preferências
Mensagem recebida
Quando um usuário é atualizado por mensagens recebidas de usuários finais por meio de canais, como SMS
Migração
Quando um usuário é atualizado por migrações internas ou scripts de manutenção
Mesclagem de usuários
Quando um usuário é atualizado pelo processo de mesclagem de usuários
Etapa de atualização do usuário do canva
Quando um usuário é atualizado pela etapa de atualização do usuário do Canva
Desinstalação de eventos
Esse evento ocorre quando um usuário desinstala um app. Use esses dados para rastrear quando os usuários desinstalam um app. Embora esse seja atualmente um evento de engajamento com mensagem, ele será alterado para um evento de comportamento do usuário no futuro.
important:
Esse evento não é disparado quando o usuário realmente desinstala o app, pois é impossível rastrear isso com exatidão. O Braze envia um push silencioso diário para determinar se o aplicativo ainda existe no dispositivo do usuário e, se recebermos um erro nesse push silencioso, presume-se que o app foi desinstalado.
//Uninstall:users.behaviors.Uninstall{"event":"(required, string) The event type name, as it is exported to Mixpanel","properties":{"$partner_id":"braze","app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","device_id":"(optional, string) ID of the device on which the event occurred","distinct_id":"(required, string) External ID of the user","$insert_id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","token":"(required, string) The Mixpanel API token"}}
1
2
3
4
5
6
7
8
9
10
11
//Uninstall:users.behaviors.Uninstall{"app_group_id":"(optional, string) API ID of the app group this user belongs to","app_id":"(required, string) API ID of the app on which this event occurred","device_id":"(optional, string) ID of the device on which the event occurred","external_user_id":"(optional, string) External ID of the user","id":"(required, string) Globally unique ID for this event","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(required, string) Braze user ID of the user who performed this event"}
//Uninstall:users.behaviors.Uninstall{"device_info":{"ios_idfv":"(optional, string) ID of the device on which the event occurred"},"environment":"(required, string) The mParticle environment (either 'development' or 'production')","events":[{"data":{"custom_attributes":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","device_id":"(optional, string) ID of the device on which the event occurred"},"source_message_id":"(required, string) Globally unique ID for this event","timestamp_unixtime_ms":"(required, int) UNIX timestamp at which the event happened"},"event_type":"(required, string) mParticle event type (either 'uninstall' or 'custom_event')"}],"schema_version":2,"user_attributes":{},"user_identities":{"customerid":"(required, string) External ID of the user"}}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
//Uninstall:users.behaviors.Uninstall{"device_id":"(optional, string) ID of the device on which the event occurred","event_properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to"},"event_type":"(required, string) The event type name, as it is exported to Amplitude","insert_id":"(required, string) Globally unique ID for this event","library":"Braze","time":"(required, int) UNIX timestamp at which the event happened","user_id":"(optional, string) External ID of the user"}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//Uninstall:users.behaviors.Uninstall{"context":{"traits":{},"device":{}},"event":"(required, string) The event type name, as it is exported to Segment","messageId":"(required, string) Globally unique ID for this event","properties":{"app_id":"(optional, string) API ID of the app on which this event occurred","app_group_id":"(optional, string) API ID of the app group this user belongs to","device_id":"(optional, string) ID of the device on which the event occurred"},"timestamp":"(required, int) UNIX timestamp at which the event happened","type":"track","userId":"(required, string) External ID of the user"}
Editar esta página no GitHub