diff --git a/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection.md b/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection.md index 67d9f6f4727..77be6a3288e 100644 --- a/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection.md +++ b/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection.md @@ -87,7 +87,6 @@ The following table lists possible returned errors and their associated troubles | Error | Troubleshooting | | -------------------- | -------------------------------------------------------- | | `catalog-not-found` | Check that the catalog name is valid. | -| `catalog-in-process` | Catalog is currently processing. Please try again later. | | `invalid-selection` | Check that the selection name is valid. | {: .reset-td-br-1 .reset-td-br-2} diff --git a/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections.md b/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections.md index c1794fc07d6..cc61678fd1b 100644 --- a/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections.md +++ b/_docs/_api/endpoints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections.md @@ -124,7 +124,6 @@ The following table lists possible returned errors and their associated troubles | `catalog-not-found` | Check that the catalog name is valid. | | `company-size-limit-already-reached` | The catalog storage size limit is reached. | | `selection-limit-reached` | The catalog selections limit is reached. | -| `catalog-in-process` | Catalog is currently processing. Please try again later. | | `invalid-selection` | Check that the selection is valid. | | `too-many-filters` | Check if the selection has too many filters. | | `selection-name-already-exists` | Check if the selection name already exists in the catalog. | diff --git a/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/troubleshooting.md b/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/troubleshooting.md index ef42321c5a3..7a772d0846a 100644 --- a/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/troubleshooting.md +++ b/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/troubleshooting.md @@ -74,6 +74,72 @@ If your app is successfully requesting and receiving in-app messages but they ar - Failed image downloads will prevent in-app messages with images from displaying. Check your device logs to ensure that image downloads are not failing. - If the device orientation did not match the orientation specified by the in-app message, the in-app message will not display. Make sure that your device is in the correct orientation. +### Troubleshooting asset loading (`NSURLError` code `-1008`) + +When integrating Braze alongside third-party network logging libraries, developers can commonly run into an `NSURLError` with the domain code `-1008`. This error indicates that assets like images and fonts could not be retrieved or failed to cache. To work around such cases, you will need to register Braze's CDN URLs to the list of domains that should be ignored by these libraries. + +#### Domains + +The full list of CDN domains is as listed below: + +* `"appboy-images.com"` +* `"braze-images.com"` +* `"cdn.braze.eu"` +* `"cdn.braze.com"` + +#### Examples + +Below are libraries that are known to conflict with Braze's asset caching, along with example code to work around the issue. If your project uses a library that causes an unavailable resource error and is not listed below, consult the documentation of that library for similar usage APIs. + +##### Netfox + +{% tabs %} +{% tab Swift %} +```swift +NFX.sharedInstance().ignoreURLs(["https://cdn.braze.com"]) +``` +{% endtab %} +{% tab Objective-C %} +```objc +[NFX.sharedInstance ignoreURLs:@[@"https://cdn.braze.com"]]; +``` +{% endtab %} +{% endtabs %} + +##### NetGuard + +{% tabs %} +{% tab Swift %} +```swift +NetGuard.blackListHosts.append(contentsOf: ["cdn.braze.com"]) +``` +{% endtab %} +{% tab Objective-C %} +```objc +NSMutableArray *blackListHosts = [NetGuard.blackListHosts mutableCopy]; +[blackListHosts addObject:@"cdn.braze.com"]; +NetGuard.blackListHosts = blackListHosts; +``` +{% endtab %} +{% endtabs %} + +##### XNLogger + +{% tabs %} +{% tab Swift %} +```swift +let brazeAssetsHostFilter = XNHostFilter(host: "https://cdn.braze.com") +XNLogger.shared.addFilters([brazeAssetsHostFilter]) +``` +{% endtab %} +{% tab Objective-C %} +```objc +XNHostFilter *brazeAssetsHostFilter = [[XNHostFilter alloc] initWithHost: @"https://cdn.braze.com"]; +[XNLogger.shared addFilters:@[brazeAssetsHostFilter]]; +``` +{% endtab %} +{% endtabs %} + [iam_1]: {{ site.baseurl }}/user_guide/administrative/app_settings/developer_console/internal_groups_tab/#adding-test-users [iam_2]: {{ site.baseurl }}/user_guide/administrative/app_settings/developer_console/event_user_log_tab/#event-user-log-tab [iam_3]: {{ site.baseurl }}/user_guide/administrative/app_settings/developer_console/event_user_log_tab/#event-user-log-tab diff --git a/_docs/_help/help_articles/email/universal_links.md b/_docs/_help/help_articles/email/universal_links.md index d9b94c97d67..e6722f3bcc7 100644 --- a/_docs/_help/help_articles/email/universal_links.md +++ b/_docs/_help/help_articles/email/universal_links.md @@ -258,7 +258,7 @@ This custom path allows you to selectively treat URLs with that value as a unive For example: ```html - + ``` Then, make sure your app is set up to handle the custom path properly. Refer to SparkPost's article on [Using SparkPost click tracking on deep links](https://support.sparkpost.com/docs/tech-resources/deep-links-self-serve#preferred-solution-using-sparkpost-click-tracking-on-deep-links). This article contains example code for [iOS](https://support.sparkpost.com/docs/tech-resources/deep-links-self-serve#ios-swift-forwarding-clicks-to-sparkpost) and [Android](https://support.sparkpost.com/docs/tech-resources/deep-links-self-serve#forwarding-clicks-from-android-to-sparkpost). diff --git a/_docs/_hidden/misc_reference/scim_api_appendix.md b/_docs/_hidden/misc_reference/scim_api_appendix.md index 412baecf267..3c4541d9b39 100644 --- a/_docs/_hidden/misc_reference/scim_api_appendix.md +++ b/_docs/_hidden/misc_reference/scim_api_appendix.md @@ -98,6 +98,7 @@ A valid team permission object is a JSON object with the following key-value pai | Import and Update User Data | `import_update_user_data` | | View Billing Details | `view_billing_details` | | Access Dev Console | `dev_console` | +| Launch Content Blocks | `launch_content_blocks` | | Manage External Integrations | `manage_external_integrations` | | Manage Apps | `manage_apps` | | Manage Teams | `manage_teams` | diff --git a/_docs/_hidden/private_betas/field_level_encryption.md b/_docs/_hidden/private_betas/field_level_encryption.md index c3ffd7ae4d5..f5bf8f2d072 100644 --- a/_docs/_hidden/private_betas/field_level_encryption.md +++ b/_docs/_hidden/private_betas/field_level_encryption.md @@ -65,7 +65,7 @@ When updating email address in Braze, you should use the hashed email value wher - Adding or updating users via CSV {% alert note %} -When creating a new user, you must add `email_encrypted` with the user's encrypted email value. Otherwise, the user will not be created. +When creating a new user, you must add `email_encrypted` with the user's encrypted email value. Otherwise, the user will not be created. Similarly, if you're adding an email address to an existing user who doesn't have an email, you must add `email_encrypted`. Otherwise, the user will not be updated. {% endalert %} ## Considerations diff --git a/_docs/_hidden/private_betas/link_shortening.md b/_docs/_hidden/private_betas/link_shortening.md index 3b9cd6f8103..9e4087620fb 100644 --- a/_docs/_hidden/private_betas/link_shortening.md +++ b/_docs/_hidden/private_betas/link_shortening.md @@ -124,6 +124,21 @@ Contact your Braze account manager if you're interested in getting started with - You can also use unique subdomains, such as `sms.braze.com`. - We recommend choosing a domain with as few characters as possible to minimize the length of your URLs. +#### Delegating your custom domain + +When you delegate your domain to Braze, we automatically handle the certificate renewal to prevent a lapse in service. + +To delegate your domain to Braze, do the following: + +1. Bring a domain that meets the above requirements to your customer success manager. Braze will then check the existing DNS configuration for the domain and confirm that: +- No CAA records exist OR +- CAA records *do* exist but have a record for {% raw %}` issue "letsencrypt.org"`{% endraw %} or {% raw %}` issuewild "letsencrypt.org"`{% endraw %} +2. Create four new A records, one for each IP, and confirm that they are the only A records that exist for the domain link host: +- 151.101.130.133 +- 151.101.194.133 +- 151.101.2.133 +- 151.101.66.133 + ### Using custom domains Once configured, custom domains can be assigned to one or multiple SMS subscription groups. diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md index cc72dcb356a..5c678e5992d 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md @@ -77,7 +77,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -128,7 +128,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "properties" : "(required, string) Custom properties stored as a JSON encoded string", "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -206,7 +206,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -261,7 +261,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "product_id" : "(required, string) ID of the product purchased", "properties" : "(required, string) Custom properties stored as a JSON encoded string", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -339,7 +339,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -388,7 +388,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "session_id" : "(required, string) UUID of the session", "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -454,7 +454,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -498,7 +498,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "platform" : "(optional, string) Platform of the device", "session_id" : "(required, string) UUID of the session", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -565,7 +565,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -611,7 +611,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "platform" : "(optional, string) Platform of the device", "session_id" : "(required, string) UUID of the session", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -681,7 +681,7 @@ This event is triggered when a user visits a specified location. Use this to tra "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -739,7 +739,7 @@ This event is triggered when a user visits a specified location. Use this to tra "os_version" : "(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", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -809,7 +809,7 @@ This event occurs when an app installation is attributed to a source. Use this t "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -844,7 +844,7 @@ This event occurs when an app installation is attributed to a source. Use this t "id" : "(required, string) Globally unique ID for this event", "source" : "(required, string) The source of the attribution", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -893,7 +893,7 @@ This user event occurs every time a new user is created within their workspace. "prev_random_bucket_number" : "(optional, int) Previous random bucket number", "random_bucket_number" : "(required, int) New random bucket number", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md index 5fa83a1787b..1ad267a3509 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md @@ -101,7 +101,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -166,7 +166,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -341,7 +341,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -410,7 +410,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -590,7 +590,7 @@ This event occurs when a send request was successfully communicated between Braz "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -656,7 +656,7 @@ This event occurs when a send request was successfully communicated between Braz "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -833,7 +833,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -900,7 +900,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -1078,7 +1078,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -1148,7 +1148,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "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) BSON ID of the user who performed this event", + "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" } ``` @@ -1330,7 +1330,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -1395,7 +1395,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -1568,7 +1568,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -1637,7 +1637,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -1817,7 +1817,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -1886,7 +1886,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2062,7 +2062,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -2122,7 +2122,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2285,7 +2285,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -2350,7 +2350,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2511,7 +2511,7 @@ This event occurs when a user has exited a Canvas by performing an event. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -2560,7 +2560,7 @@ This event occurs when a user has exited a Canvas by performing an event. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2692,7 +2692,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -2741,7 +2741,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2875,7 +2875,7 @@ This event occurs when a user enters a Canvas experiment step path. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -2926,7 +2926,7 @@ This event occurs when a user enters a Canvas experiment step path. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3072,7 +3072,7 @@ This event occurs when a user convert for a Canvas experiment step. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -3127,7 +3127,7 @@ This event occurs when a user convert for a Canvas experiment step. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3287,7 +3287,7 @@ This event occurs when Braze processes a push message for a user, communicating "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -3358,7 +3358,7 @@ This event occurs when Braze processes a push message for a user, communicating "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3557,7 +3557,7 @@ This event occurs when a user directly clicks on the Push notification to open t "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -3633,7 +3633,7 @@ This event occurs when a user directly clicks on the Push notification to open t "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3830,7 +3830,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -3901,7 +3901,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4036,7 +4036,7 @@ This event occurs when an error is received from either Apple Push Notification "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -4105,7 +4105,7 @@ This event occurs when an error is received from either Apple Push Notification "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4293,7 +4293,7 @@ This event occurs when an email send request was successfully communicated betwe "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -4357,7 +4357,7 @@ This event occurs when an email send request was successfully communicated betwe "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4544,7 +4544,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -4611,7 +4611,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4802,7 +4802,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -4884,7 +4884,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5102,7 +5102,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -5188,7 +5188,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5406,7 +5406,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -5477,7 +5477,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5668,7 +5668,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -5737,7 +5737,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5924,7 +5924,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -5992,7 +5992,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6181,7 +6181,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -6243,7 +6243,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6424,7 +6424,7 @@ This event occurs when a user views an in-app message. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -6500,7 +6500,7 @@ This event occurs when a user views an in-app message. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6709,7 +6709,7 @@ This event occurs when a user clicks on an in-app message. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -6785,7 +6785,7 @@ This event occurs when a user clicks on an in-app message. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6984,7 +6984,7 @@ This event occurs when a webhook was processed and sent to the third party speci "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -7043,7 +7043,7 @@ This event occurs when a webhook was processed and sent to the third party speci "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -7214,7 +7214,7 @@ This event occurs when a Content Card gets sent to a user. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -7276,7 +7276,7 @@ This event occurs when a Content Card gets sent to a user. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -7455,7 +7455,7 @@ This event occurs when a user views a Content Card. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -7529,7 +7529,7 @@ This event occurs when a user views a Content Card. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -7730,7 +7730,7 @@ This event occurs when a user clicks a Content Card. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -7804,7 +7804,7 @@ This event occurs when a user clicks a Content Card. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -8006,7 +8006,7 @@ This event occurs when a user dismisses a Content Card. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -8080,7 +8080,7 @@ This event occurs when a user dismisses a Content Card. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -8277,7 +8277,7 @@ This event occurs when a user clicks an SMS short link. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -8339,7 +8339,7 @@ This event occurs when a user clicks an SMS short link. "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_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" } ``` @@ -8514,7 +8514,7 @@ This event occurs when a user sends an SMS. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -8580,7 +8580,7 @@ This event occurs when a user sends an SMS. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -8767,7 +8767,7 @@ This event occurs when an SMS is sent to the carrier. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -8831,7 +8831,7 @@ This event occurs when an SMS is sent to the carrier. "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9008,7 +9008,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -9072,7 +9072,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9251,7 +9251,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -9319,7 +9319,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9504,7 +9504,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -9570,7 +9570,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9752,7 +9752,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -9816,7 +9816,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "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) BSON ID of the user who performed this event", + "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" } ``` @@ -9990,7 +9990,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -10041,7 +10041,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10196,7 +10196,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -10248,7 +10248,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10397,7 +10397,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -10445,7 +10445,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10587,7 +10587,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -10634,7 +10634,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10791,7 +10791,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -10859,7 +10859,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -11057,7 +11057,7 @@ This event occurs when Braze receives a request to update the global subscriptio "user" : { "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -11121,7 +11121,7 @@ This event occurs when Braze receives a request to update the global subscriptio "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -11298,7 +11298,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id": (required, string) Braze user ID of the user who performed this event" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } } ``` @@ -11334,7 +11334,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "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" + "user_id" : "(required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} diff --git a/_docs/_user_guide/data_and_analytics/custom_data/custom_attributes.md b/_docs/_user_guide/data_and_analytics/custom_data/custom_attributes.md index 163794bc56d..64cae6a89b0 100644 --- a/_docs/_user_guide/data_and_analytics/custom_data/custom_attributes.md +++ b/_docs/_user_guide/data_and_analytics/custom_data/custom_attributes.md @@ -45,7 +45,9 @@ This feature is currently in early access. Contact your customer success manager ### Removing custom attributes -To remove custom attributes from user profiles, set the value to "null" in your API request to the [`/users/track` endpoint]({{site.baseurl}}/api/endpoints/user_data/post_user_track#user-track). +There are two ways you can remove custom attributes from user profiles: +* Select the custom attribute name to be removed in a [User Update step]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/user_update/#removing-custom-attributes). +* Set the `null` value in your API request to the [`/users/track` endpoint]({{site.baseurl}}/api/endpoints/user_data/post_user_track#user-track). ### Viewing usage reports diff --git a/_docs/_user_guide/data_and_analytics/report_metrics.md b/_docs/_user_guide/data_and_analytics/report_metrics.md index 458febee797..5bef55cda87 100644 --- a/_docs/_user_guide/data_and_analytics/report_metrics.md +++ b/_docs/_user_guide/data_and_analytics/report_metrics.md @@ -379,7 +379,7 @@ The SMS has been rejected by the carrier. This can happen for a number of reason ### Sends {% apitags %} -Content Cards, Email, In-App Message, Web Push, iOS Push, Android Push, Webhook, SMS, WhatsApp +Content Cards, Email, In-App Message, Web Push, iOS Push, Android Push, Webhook, SMS, WhatsApp, LINE {% endapitags %} *Sends*, or *Messages Sent*, is the total number of messages sent in a campaign. Upon launching a scheduled campaign, this metric will include all messages sent, regardless of whether they have been sent out yet due to rate limiting. This does not mean the message was received or delivered to a device, only that the message was sent. This metric is provided by Braze. @@ -453,10 +453,10 @@ Total clicks on the submit button of a [simple survey]({{site.baseurl}}/user_gui ### Total Clicks {% apitags %} -Email, Content Cards +Email, Content Cards, LINE {% endapitags %} -The total number (and percentage) of users who clicked within the delivered email or card. +The total number (and percentage) of users who clicked within the delivered email, card, or message. For LINE, this is tracked after a minimum threshold of 20 messages per day has been reached. {::nomarkdown} @@ -503,10 +503,10 @@ The number of times the in-app message has been viewed (if a user is shown a mes ### Total Opens {% apitags %} -Email, iOS Push, Android Push, Web Push +Email, iOS Push, Android Push, Web Push, LINE {% endapitags %} -The total number of messages that were opened. +The total number of messages that were opened. For LINE, this is tracked after a minimum threshold of 20 messages per day has been reached. {::nomarkdown} @@ -539,11 +539,13 @@ The total revenue in dollars from campaign recipients within the set primary con ### Unique Clicks {% apitags %} -Email, Content Cards +Email, Content Cards, LINE {% endapitags %} Distinct number of recipients who have clicked within a message at least once. This is tracked over a 7-day period for Email. Note that clicks on Braze-provided unsubscribe links are counted as unique clicks. +For LINE, this is tracked after a minimum threshold of 20 messages per day has been reached. + {::nomarkdown} Calculation: @@ -589,10 +591,10 @@ The total number of users who received and viewed a given in-app message or card ### Unique Opens {% apitags %} -Email +Email, LINE {% endapitags %} -The total number of delivered emails that have been opened by a single user at least once. This is tracked over a 7-day period for Email. +For emails, this is the total number of delivered emails that have been opened by a single user at least once. This is tracked over a 7-day period for Email. For LINE, this is tracked after a minimum threshold of 20 messages per day has been reached. Calculation: (Unique Opens) / (Deliveries) diff --git a/_docs/_user_guide/engagement_tools/landing_pages/drag_and_drop.md b/_docs/_user_guide/engagement_tools/landing_pages/drag_and_drop.md index c785bc15bac..8ab54c6f605 100644 --- a/_docs/_user_guide/engagement_tools/landing_pages/drag_and_drop.md +++ b/_docs/_user_guide/engagement_tools/landing_pages/drag_and_drop.md @@ -15,16 +15,13 @@ alias: /landing_pages/drag_and_drop/ Landing pages are currently in beta. Contact your Braze account manager if you're interested in participating in this beta. {% endalert %} -![GIF demonstrating how components can be dragged and dropped into an editor to create a landing page.][1]{: style="max-width:70%;"} - - ## Creating a landing page (drag-and-drop) ### Step 1: Create a landing page Go to **Messaging** > **Landing Pages** and select **Create landing page**, or select the name of an existing one to duplicate it or make changes to it. -![The "Landing Pages" page showing a list of existing landing pages and a button to "Create landing page".][2]{: style="max-width:70%;"} +![The "Landing Pages" homepage.][2]{: style="max-width:90%;"} ### Step 2: Set up your landing page details @@ -50,13 +47,11 @@ We suggest following these best practices: Custom subdomain support is not available during the beta. {% endalert %} -![Tab to provide a landing page's site details.][3]{: style="max-width:70%;"} - ### Step 3: Customize your landing page Select **Launch Editor** to start designing your landing page in the drag-and-drop editor. The editor will preload with a default template that you can customize to fit your use case. -![Landing page template with a form for customer sign-up.][8]{: style="max-width:70%;"} +![Landing page template with a form for customer sign-up.][8]{: style="max-width:90%;"} #### Drag-and-drop blocks @@ -80,9 +75,9 @@ We recommend setting up page container-level styles before you customize styles ### Step 4: Preview your landing page -You can preview your landing page in the editor's **Preview** tab, but testing functionality is disabled for the beta. After saving your landing page as a draft, you can visit the URL under **URL handle** to preview the page on your browser. You can also share the URL with collaborators. +You can preview your landing page in the editor's **Preview** tab, but testing functionality is disabled for the beta. After saving your landing page as a draft, you can visit the URL by going to **Landing Pages** and selecting **Copy URL** next to your landing page. You can also share the URL with collaborators. -![The "URL handle" section has the full URL to preview the landing page.][7]{: style="max-width:70%;"} +![A landing page with the menu open to show the "Copy URL" option.][7]{: style="max-width:90%;"} After you're satisfied with the landing page, select **Publish Landing Page**. @@ -100,7 +95,7 @@ In beta, you can include a link to the landing page in any channel by copying an ## Handling form submission errors -If a user inputs an invalid form value (such as unaccepted special characters), they will see a generic error indicator that isn't customizable and won't be able to submit the form. You can view the error behavior in the **Preview** tab and the preview landing page. +If a user inputs an invalid form value (such as unaccepted special characters), they will see a generic error indicator that isn't customizable and won't be able to submit the form. You can view the error behavior on the preview landing page. ## Merging users created from your landing page @@ -132,6 +127,10 @@ No, this isn't currently available. No, this isn't currently available. +### Is there an HTML editor for landing pages? + +No, this isn’t currently available. You can use the Custom Code block in the editor. + [1]: {% image_buster /assets/img/landing_pages/homepage.gif %} [2]: {% image_buster /assets/img/landing_pages/create.png %} [3]: {% image_buster /assets/img/landing_pages/details.png %} diff --git a/_docs/_user_guide/message_building_by_channel/in-app_messages/drag_and_drop/create.md b/_docs/_user_guide/message_building_by_channel/in-app_messages/drag_and_drop/create.md index 2e1bc2f573c..e1770506be9 100644 --- a/_docs/_user_guide/message_building_by_channel/in-app_messages/drag_and_drop/create.md +++ b/_docs/_user_guide/message_building_by_channel/in-app_messages/drag_and_drop/create.md @@ -75,10 +75,6 @@ You can also access all templates from the **Templates** section of the dashboar Adding pages to your in-app message lets you guide users through a sequential flow, like an onboarding flow or welcome journey. You can manage pages from the **Pages** section of the **Build** tab. -{% alert note %} -The ability to add pages to your in-app message is in early access. Contact your Braze account manager if you’re interested in participating in the early access for multi-page in-app messages. -{% endalert %} - ![]({% image_buster /assets/img_archive/dnd_iam_mockup.png %}) {% tabs %} diff --git a/_docs/_user_guide/message_building_by_channel/line.md b/_docs/_user_guide/message_building_by_channel/line.md new file mode 100644 index 00000000000..fa844e57a03 --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/line.md @@ -0,0 +1,32 @@ +--- +nav_title: LINE +article_title: LINE +page_order: 3 +layout: dev_guide +channel: + - LINE +guide_top_header: "LINE" +guide_top_text: "[LINE](https://www.lycbiz.com/sites/default/files/media/jp/download/LINE%20Business%20Guide_202310-202403.pdf) is the most popular messaging app in Japan, with over 95 million monthly active users. In addition to messaging, LINE offers its users an “all-in-one” platform for social media, gaming, shopping, and payments.

You can integrate your LINE accounts with Braze to leverage your zero- and first-party customer data to send compelling LINE messages to the right customers based on their preferences, behaviors, and cross-channel interactions.

LINE access is in beta and only available in select Braze packages. Reach out to your account manager or customer success manager to get started." +description: "This landing page is home to the LINE channel. Here, you can find articles on setting up LINE, LINE subscription groups, LINE campaigns, LINE reporting, and more." +hidden: true +permalink: /line/ + +guide_featured_title: "LINE" +guide_featured_list: +- name: LINE Setup + link: https://www.braze.com/docs/line/line_setup/ + image: /assets/img/braze_icons/phone-02.svg +- name: Create a LINE Message + link: https://www.braze.com/docs/line/create/ + image: /assets/img/braze_icons/table.svg +- name: Messaging LINE Users + link: https://www.braze.com/docs/line/messaging_users/ + image: /assets/img/braze_icons/message-chat-circle.svg +- name: LINE Subscription Groups + link: https://www.braze.com/docs/line/subscription_groups/ + image: /assets/img/braze_icons/table.svg +- name: LINE Reporting + link: https://www.braze.com/docs/line/reporting/ + image: /assets/img/braze_icons/bar-chart-01.svg +--- +

\ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/line/create.md b/_docs/_user_guide/message_building_by_channel/line/create.md new file mode 100644 index 00000000000..b979049bce4 --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/line/create.md @@ -0,0 +1,135 @@ +--- +nav_title: Creating a LINE Message +article_title: Creating a LINE Message +page_order: 1 +description: "This article covers how to create a LINE message campaign or Canvas." +page_type: reference +tool: + - Campaigns +channel: + - LINE +hidden: true +permalink: /line/create/ +--- + +# Creating a LINE message + +> LINE campaigns can directly reach and programmatically chat with your customers. You can use Liquid and other dynamic content to create a personal experience with your users and create an environment that fosters and enhances an unobtrusive user experience with your brand.

This article is part of the LINE beta collection. [Return to the main page](https://www.braze.com/docs/line/). + +{% alert important %} +LINE access is in beta and only available in select Braze packages. Reach out to your account manager or customer success manager to get started. +{% endalert %} + +## Prerequisites + +Before creating a LINE message, do the following: + +1. Read the LINE overview. +2. Acknolwedge policies, limits, and content rules. +3. [Set up your LINE connection]({{site.basesurl}}/user_guide/message_building_by_channel/line/line_setup/). + + +## Step 1: Choose where to build your message + +Not sure whether your message should be sent using a campaign or a Canvas? Campaigns are better for single, simple messaging campaigns, while Canvases are better for multi-step user journeys. + +{% tabs %} +{% tab Campaign %} + +**Steps:** + +1. Go to **Messaging** > **Campaigns** and select **Create Campaign**. +{% alert note %} +If you are using the [older navigation]({{site.baseurl}}/navigation), you can find **Campaigns** under **Engagement**. +{% endalert %} + +{: start="2"} +2. Select **LINE**, or, for campaigns targeting multiple channels, select **Multichannel Campaign**. +3. Name your campaign something clear and meaningful. +4. Add [Teams]({{site.baseurl}}/user_guide/administrative/manage_your_braze_users/teams/) and [Tags]({{site.baseurl}}/user_guide/administrative/app_settings/manage_app_group/tags/) as needed. + * Tags make your campaigns easier to find and build reports out of. For example, when using the [Report Builder]({{site.baseurl}}/user_guide/data_and_analytics/reporting/report_builder/), you can filter by particular tags. +5. Add and name as many variants as you need for your campaign. You can choose different platforms, message types, and layouts for each of your added variants. For more on this topic, refer to [Multivariate and A/B testing]({{site.baseurl}}/user_guide/engagement_tools/testing/multivariant_testing/). +6. Select a [subscription group]({{site.baseurl}}/user_guide/message_building_by_channel/sms/sms_subscription_group/) to ensure you're sending your message to the proper users. When selecting a subscription group, Braze will automatically add a segmenting filter, ensuring that only users subscribed will receive the campaign. Only long codes and short codes that belong to that subscription group will be used to send SMS to target users. + +{% alert tip %} +If all of the messages in your campaign are going to be similar or have the same content, compose your message before adding additional variants. You can then choose **Copy from Variant** from the **Add Variant** dropdown. +{% endalert %} + +{% endtab %} +{% tab Canvas %} + +**Steps:** + +1. [Create your Canvas]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas/) using the Canvas composer. +2. After you've set up your Canvas, add a step in the Canvas builder. Name your step something clear and meaningful. +3. Choose a [step schedule]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/time_based_canvas/#schedule-delay) and specify a delay as needed. +4. Filter your audience for this step as necessary. You can further refine the recipients of this step by specifying segments and adding additional filters. Audience options will be checked after the delay at the time messages are sent. +5. Choose your [advancement behavior]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/advancement/). +6. Choose any other messaging channels which you would like to pair with your message. + +{% endtab %} +{% endtabs %} + +## Step 2: Compose your LINE message + +Write your message using languages and personalization (such as Liquid or Connected Content) as needed. LINE allows up to five message bubbles in each message, which can be text or image messages. + +![LINE composer with a message displayed in the preview.][1]{: style="max-width:70%;"} + +{% alert tip %} +If you plan to use Liquid, be sure to include a default value for your personalization. This will prevent recipients with incomplete user profiles from receiving a blank placeholder. For example, instead of a user receiving the message "Hi, !", they might receive the message "Hi, new subscriber!". +{% endalert %} + +## Step 3: Preview and test your message + +Switch to the **Test** tab to send a test LINE message to content test groups or individual users, or preview the message as a user directly in Braze. + +![The "Tests" tab displaying a preview of a test message.][2] + +## Step 4: Build the remainder of your campaign or Canvas + +{% tabs %} +{% tab Campaign %} + +Build the remainder of your campaign. See the following sections for further details on how to best use our tools to build LINE messages. + +### Choose delivery schedule or trigger + +LINE messages can be delivered based on a scheduled time, an action, or an API trigger. For more about scheduling and trigger options, refer to [Scheduling your campaign]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/). + +You can specify delivery controls, such as allowing users to become [re-eligible]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/reeligibility/#campaigns) to receive the campaign, or turning on [frequency capping]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/rate-limiting/#frequency-capping) rules. For action-based delivery, you can also set the campaign's duration and [quiet hours]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/time_based_campaign/#quiet-hours). + +### Choose users to target + +[Target users]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/targeting_users/) by choosing segments or filters to narrow down your audience. You should have already chosen the subscription group, which narrows users by the level or category of communication they wish to have with you. + +Select the larger audience from your segments, and optionally narrow that segment further with our [filters]({{site.baseurl}}/user_guide/engagement_tools/segments/segmentation_filters/). You'll automatically be given a snapshot of what that approximate segment population looks like right now. Keep in mind that exact segment membership is always calculated just before the message is sent. + +### Choose conversion events + +Braze allows you to track how often users perform specific actions, [conversion events]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/conversion_events/), after receiving a campaign. You have the option of allowing up to a 30-day window during which a conversion will be counted if the user takes the specified action. + +Conversion events help you measure the success of your campaign. For example: + +- If you are using geotargeting to trigger a LINE message that has an end goal of the user making a purchase, set the conversion event to a `Purchase`. +- If you're trying to drive the user to your app, set the conversion event to `Starts Session`. + +You can also set custom conversion events based on your specific use case. Get creative and think about how you want to measure this campaign's success. + +{% endtab %} +{% tab Canvas %} + +If you haven’t already, complete the remaining sections of your Canvas. For further details on how to build the rest of your Canvas, use multivariate testing and Intelligent Selection, and more, refer to [Creating a Canvas](/user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas/). + +{% endtab %} +{% endtabs %} + +## Step 5: Review and deploy + +After you’ve finished building the last of your campaign or Canvas, review its details, test it, then send it! + +Next, check out [LINE reporting](https://www.braze.com/docs/line/reporting/) to learn how you can access the results of your LINE campaigns. + + +[1]: {% image_buster /assets/img/line/line_composer.png %} +[2]: {% image_buster /assets/img/line/test_preview.png %} \ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/line/line_setup.md b/_docs/_user_guide/message_building_by_channel/line/line_setup.md new file mode 100644 index 00000000000..b24bb850402 --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/line/line_setup.md @@ -0,0 +1,134 @@ +--- +nav_title: LINE Setup +article_title: LINE Setup +description: "This article covers how to set up the Braze LINE channel, including prerequisites and suggested next steps." +page_type: partner +search_tag: Partner +page_order: 0 +channel: + - LINE +hidden: true +permalink: /line/line_setup/ +--- + + +# LINE setup + +> This article covers how to set up the LINE channel in Braze and is part of the LINE beta collection. [Return to the main page](https://www.braze.com/docs/line/). + +{% alert important %} +LINE access is in beta and only available in select Braze packages. Reach out to your account manager or customer success manager to get started. +{% endalert %} + +## Prerequisites + +You'll need the following to integrate LINE with Braze: + +- [LINE business account](https://www.linebiz.com/jp-en/manual/OfficialAccountManager/tutorial-steps/?list=7171) +- [Premium or verified account](https://www.infobip.com/docs/line/get-started#premium-id-line-official-account) status (necessary for syncing existing followers) + - View [LINE's account guidelines](https://terms2.line.me/official_account_guideline_oth) +- [LINE developers account](https://developers.line.biz/en/docs/line-developers-console/login-account/) +- [LINE messaging API channel](https://developers.line.biz/en/docs/line-developers-console/overview/#channel) + +## Integration + +### Step 1: Connect your LINE channel to Braze + +1. In LINE, go the **Messaging API** tab and edit your **Webhook settings**: + - Set the **Webhook URL** to `https://anna.braze.com/line/events`. + - Braze will automatically change this to a different URL when integrating, based on your dashboard cluster. + - Turn on **Use webhook** and **Webhook redelivery**.

![Webhook settings page to verify or edit the webhook URL, toggling on or off "Use webhook", "Webhook redelivery", and "Error statistics aggregation".][1]{: style="max-width:70%;"} +2. Take note of the following information in the **Providers** tab: + +| Information type | Location | +| --- | --- | +| Provider ID | Select your provider and then go to ***Settings** > **Basic information** | +| Channel ID | Select your provider and then go to **Channels** > your channel > **Basic settings** | +| Channel secret | Select your provider and then go to **Channels** > your channel > **Basic settings** | +| Channel access token | Select your provider and then go to **Channels** > your channel > **Messaging API**. If there isn't a channel access token, select **Issue**. | +{: .reset-td-br-1 .reset-td-br-2} + +{: start="3"} +3. Go to your **Settings** page > **Response settings** and do the following: + - Turn off **Greeting message**. This can be handled in Braze via trigger on follow. + - Turn off **Auto-response messages**. All triggered messaging should be through Braze. This won't prevent you from sending directly from the LINE console. + - Turn on **Webhooks**. + +![Response settings page with toggles for how your account will handle chats.][2]{: style="max-width:80%;"} + +### Step 2: Set up your LINE page in Braze + +1. Go to the Braze Technology Partners page for LINE and input the information you noted from your LINE **Providers** tab: + - Provider ID + - Channel ID + - Channel secret + - Channel access token + +![LINE messaging integration page with LINE integration section.][3]{: style="max-width:80%;"} + +{: start="2"} +2. After connecting, Braze will automatically generate a Braze subscription group for each LINE integration that's successfully added to your workspace.

Any changes to your followers list (such as new followers or unfollowers) will be automatically pushed into Braze. + +![LINE subscription groups section displaying one subscription group for the "LINE" channel.][4]{: style="max-width:80%;"} + +## Types of LINE accounts + +| Account type | Description | +| --- | --- | +| Unverified account | An unreviewed account that can be obtained by anyone (individual or corporate). This account is represented with a gray badge and won't appear in search results within the LINE app. | +| Verified account | An account that has passed the LINE Yahoo screening. This account is represented with a blue badge and will appear in search results within the LINE app.

This account is only available for accounts based in Japan, Taiwan, Thailand, and Indonesia. | +| Premium account | An account that has passed the LINE Yahoo screening. This account is represented with a green badge and will appear in search results within the LINE app. This account type is automatically granted during the screening at LINE's discretion. | +{: .reset-td-br-1 .resest-td-br-2} + +## Sync existing followers into Braze + +To sync followers into Braze, your LINE account needs to be verified or premium. When you create an account, its default status will be unverified. You'll need to request account verification. + +### Applying for a verified LINE account + +{% alert important %} +Verified accounts are only available for accounts based in Japan, Taiwan, Thailand, and Indonesia. +{% endalert %} + +1. On the LINE **Official Account** page, select **Settings**. +2. Under **Information Disclosure Verification Status**, select **Request Account Verification**. +3. Enter the required information. +4. Wait for a notification with the review results. + +If you want to sync users who followed a specific channel before that channel was synced with Braze, ask your customer success manager or account manager to [submit a request](https://servicedesk.braze.com/plugins/servlet/desk/portal/12) to the WhatsApp team. + +## Create LINE test users in Braze + +You can test your LINE channel before setting up user reconciliation in two ways: + +### Reference your LINE segment + +1. After connecting your account, follow your LINE channel. + +2. In Braze, go to **Segments** and create a segment for your LINE subscription group.

![Filter group with a subscription group.][5]{: style="max-width:80%;"}

+ +3. Select **User Data** > **CSV Export User Data**.

![Segment Details with a segment named "line subscribed" and the "User Data" menu with a list of export options.][6]{: style="max-width:80%;"}

+ +4. In the CSV download, reference the `created_at` field and when you followed your LINE channel to find your users. + +5. In Braze, use the Appboy ID to search for specific users and modify them as needed. + +### Create a "Who am I" Canvas or campaign + +1. Set up a Canvas that returns a user's Braze user ID on a specific trigger word.

Example trigger

![Trigger to send the campaign to users who sent an inbound LINE to a specific subscription group.][7]{: style="max-width:80%;"}

Example message

![LINE message stating the Braze user ID.][8]{: style="max-width:40%;"}

+ +2. In Braze, you can use the Braze ID to search for specific users and modify them as needed. + +{% alert important %} +Make sure the Canvas doesn't have global control or control groups preventing sends. +{% endalert %} + + +[1]: {% image_buster /assets/img/line/webhook_settings.png %} +[2]: {% image_buster /assets/img/line/response_settings.png %} +[3]: {% image_buster /assets/img/line/integration.png %} +[4]: {% image_buster /assets/img/line/line_subscription_groups.png %} +[5]: {% image_buster /assets/img/line/filter_group.png %} +[6]: {% image_buster /assets/img/line/csv_export_user_data.png %} +[7]: {% image_buster /assets/img/line/trigger.png %} +[8]: {% image_buster /assets/img/line/message.png %} \ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/line/messaging_users.md b/_docs/_user_guide/message_building_by_channel/line/messaging_users.md new file mode 100644 index 00000000000..81b96fa3a97 --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/line/messaging_users.md @@ -0,0 +1,56 @@ +--- +nav_title: Messaging Users +article_title: Messaging LINE Users +page_order: 2 +description: "This reference article covers how chat with users by using templated campaigns and Canvases." +page_type: reference +channel: + - LINE +hidden: true +permalink: /line/messaging_users/ +--- + +# Messaging LINE users + +> LINE is a two-way communication channel. You can go beyond sending users messages and engage in conversations with users by using templated campaigns and Canvases.

This article is part of the LINE beta collection. [Return to the main page](https://www.braze.com/docs/line/). + +There are various methods to converse with users through LINE, such as using LINE trigger words. You can also use calls-to-action (CTAs) to encourage user engagement with your LINE messaging. + +{% alert important %} +LINE access is in beta and only available in select Braze packages. Reach out to your account manager or customer success manager to get started. +{% endalert %} + +## Action-based triggers + +You can create campaigns and Canvases that start, branch, and have mid-journey changes when you receive an inbound LINE message (a message sent from a user) that contains a trigger word. Make sure you choose trigger words that match what you expect users to send. + +### Campaign + +Set your trigger words when scheduling an action-based delivery campaign. + +![Action-based trigger of "Send this campaign to users who sent inbound LINE to subscription group where the message body is" and a blank field.][1] + +### Canvas + +Set your trigger words within [action paths]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/action_paths) in your Canvas. + +![Action path with a trigger of "Send this campaign to users who sent inbound LINE to subscription group where the message body is" and a blank field.][2] + +### Requirements + +Each letter of your trigger word must be capitalized when building your campaign or Canvas, even though Braze doesn't require inbound trigger words to be capitalized. For example, if your trigger word is "JOIN2023", an inbound message of “jOin2023” will still trigger the Canvas or campaign. + +If no trigger word is specified, the campaign or Canvas will run for *all* inbound LINE messages. This includes messages that have matched phrases across active campaigns and Canvases, in which case the user will receive two LINE messages. + +## Unrecognized responses + +You should include a trigger option for unrecognized responses on interactive Canvases. This informs users of the available prompts (or trigger words) and sets their expectations for the channel. + +### Creating a trigger for unrecognized responses + +After creating action groups for the custom filter phrases, add another action group to the action path for **Send LINE message**, and don't check **Where the message body**. This will catch all unrecognized user responses, similar to an “else” clause. + +For this message, you should send a LINE message informing the user that this channel is not monitored by a human and, if needed, guide them to a support channel. + +[1]: {% image_buster /assets/img/line/trigger_word_campaign.png %} +[2]: {% image_buster /assets/img/line/trigger_word_canvas.png %} \ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/line/reporting.md b/_docs/_user_guide/message_building_by_channel/line/reporting.md new file mode 100644 index 00000000000..2a11e779ceb --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/line/reporting.md @@ -0,0 +1,78 @@ +--- +nav_title: Reporting +article_title: LINE Reporting +page_order: 4 +description: "This reference article covers LINE metrics used at Braze, as well as how to view them in your LINE campaigns." +page_type: reference +channel: + - LINE +hidden: true +permalink: /line/reporting/ +--- + +# LINE reporting + +> After launching your campaign or Canvas, you can view key metrics on the campaign details page or Canvas analytics.

This article is part of the LINE beta collection. [Return to the main page](https://www.braze.com/docs/line/). + +{% alert tip %} +Looking for definitions for the terms and metrics in your report? Refer to [Report metrics glossary]({{site.baseurl}}/user_guide/data_and_analytics/report_metrics/). +{% endalert %} + +## Campaign analytics + +In the **Campaign Analytics** tab, you can view your reports in a series of panels. You might see more or less than those listed in the sections below, but each has its purpose. + +{% alert note %} +Open and click-related statistics for LINE are only calculated if more than 20 users perform the event on a given day. +{% endalert %} + +### Campaign details + +The **Campaign Details** panel shows a high-level overview of your LINE messages' performance. + +Review this panel to see overall metrics such as the number of messages sent to the number of recipients, the primary conversion rate, and the total revenue generated by this message. You can also review delivery, audience, and conversion settings from this page. + +#### Control groups + +To measure the impact of an individual LINE message, you can add a [control group]({{site.baseurl}}/user_guide/intelligence/multivariate_testing/) to an A/B test. The top-level **Campaign Details** panel doesn’t include metrics from the Control Group variant. + +### LINE performance + +The **LINE Performance** panel outlines how well your message has performed across various dimensions. The metrics in this panel vary depending on your chosen messaging channel, and whether or not you are running a multivariate test. You can click on the **Preview** icon to view your message for each variant or channel. + +![The "LINE Performance" panel show metrics for two variants.][1] + +If you want to simplify your view, select **+ Add/Remove Columns** and clear any metrics as desired. By default, all metrics are displayed. + +#### LINE metrics + +Here are some key LINE metrics you may see in your analytics. To see the definitions of all LINE metrics used in Braze, refer to [Report metrics glossary]({{site.baseurl}}/user_guide/data_and_analytics/report_metrics/). + +| Term | Definition | +| Sends | The total number of sends successfully communicated between Braze and LINE. This does not mean the message was received by the user. | +| Unique Opens | The total number of LINE messages sent that were opened by users after a minimum threshold of 20 messages per day has been reached. | +| Total Opens | The total number of times that the LINE messages sent were opened by users after a minimum threshold of 20 messages per day has been reached. | +| Unique Clicks | The total number of LINE messages sent that were clicked by users, after a minimum threshold of 20 messages per day has been reached. | +| Total Clicks | The total number of times that the LINE messages sent were clicked by users after a minimum threshold of 20 messages per day has been reached. | +{: .reset-td-br-1 .reset-td-br-2 } + +### Historical performance + +The **Historical Performance** panel allows you to view the metrics from the **Message Performance** panel as a graph over time. Use the filters at the top of the panel to modify the stats and channels shown in the graph. The time range of this graph will always mirror the time range specified at the top of the page. + +To get a day-by-day breakdown, select the hamburger menu and select **Download CSV** to receive a CSV export of the report. + +### Conversion event details + +The **Conversion Event Details** panel shows you the performance of your conversion events for your campaign. For more information, refer to [Conversion events]({{site.baseurl}}/user_guide/engagement_tools/testing/conversion_correlation). + +### Conversion correlation + +The **Conversion Correlation** panel gives you insight into what user attributes and behaviors help or hurt the outcomes you set for campaigns. For more information, refer to [Conversion correlation]({{site.baseurl}}/user_guide/engagement_tools/testing/conversion_correlation). + +## LINE user IDs + +LINE user IDs are specific to each user per provider. Users are unlikely to know their LINE ID (unlike their email or phone number), as their LINE ID changes for each brand they follow. + + +[1]: {% image_buster /assets/img/line/line_performance.png %} \ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/line/subscription_groups.md b/_docs/_user_guide/message_building_by_channel/line/subscription_groups.md new file mode 100644 index 00000000000..7d4c4932a28 --- /dev/null +++ b/_docs/_user_guide/message_building_by_channel/line/subscription_groups.md @@ -0,0 +1,29 @@ +--- +nav_title: Subscription Groups +article_title: Subscription Groups +page_order: 3 +description: "This article covers LINE message subscription groups." +page_type: reference +channel: + - LINE +hidden: true +permalink: /line/subscription_groups/ +--- + +# LINE subscription groups + +> There are two subscription states for LINE users: subscribed and unsubscribed. LINE can have up to 100 subscription groups per workspace, with each subscription group connected to its own LINE channel.

This article is part of the LINE beta collection. [Return to main page](https://www.braze.com/docs/line/). + +{% alert important %} +LINE access is in beta and only available in select Braze packages. Reach out to your account manager or customer success manager to get started. +{% endalert %} + +| State | Definition | +| --- | --- | +| Subscribed | The user followed the LINE channel from within their LINE app. Users are automatically subscribed when they follow after you've completed the integration steps. | +| Unsubscribed | The user didn't follow the LINE channel from within their LINE app, or the user explicitly unfollowed the LINE channel.

Users who unsubscribe from a LINE subscription group will no longer receive any LINE messages from sending channels that belong to the subscription group. | +{: .reset-td-br-1 .reset-td-br-2 } + +## Setting a user's LINE subscription group + +LINE hosts the users' subscription status. Braze processes the follow and unfollow events that update the subscription status. \ No newline at end of file diff --git a/_docs/_user_guide/message_building_by_channel/push.md b/_docs/_user_guide/message_building_by_channel/push.md index 1409ab65ecc..3016c37ce11 100644 --- a/_docs/_user_guide/message_building_by_channel/push.md +++ b/_docs/_user_guide/message_building_by_channel/push.md @@ -1,7 +1,7 @@ --- nav_title: Push article_title: Push -page_order: 3 +page_order: 4 layout: dev_guide guide_top_header: "Push" guide_top_text: "Push messages are a tried-and-true way to reach your customers via mobile or web. They're useful for driving a user to a specific place, but you should use them wisely. Read any of the following articles or check out our [Push Braze Learning course](https://learning.braze.com/messaging-channels-push) to learn who you can send a push to, how to send it, and what advanced push capabilities Braze offers." diff --git a/_includes/feedback.html b/_includes/feedback.html index cc2b0a69892..abaa4ae23d6 100644 --- a/_includes/feedback.html +++ b/_includes/feedback.html @@ -35,4 +35,6 @@ \ No newline at end of file diff --git a/_lang/ja/_developer_guide/platform_wide/getting_started/platform_overview.md b/_lang/ja/_developer_guide/platform_wide/getting_started/platform_overview.md index fbdbb8e14bd..ccd06c795d2 100644 --- a/_lang/ja/_developer_guide/platform_wide/getting_started/platform_overview.md +++ b/_lang/ja/_developer_guide/platform_wide/getting_started/platform_overview.md @@ -19,7 +19,7 @@ platform: > この記事では、 Braze プラットフォームの基本的な部品と機能について説明します。この記事からのリンクは、必須の Braze ・トピックに接続します。 -## ろう付けとは。 +## Brazeとは？ Braze は顧客エンゲージメントプラットフォームです。つまり、Brazeはユーザーの話を聞き、ユーザーの行動や行動を理解し、それに基づいて行動するのに役立ちます。Braze プラットフォームには、SDK、ダッシュボード、およびREST API の3 つの主要コンポーネントがあります。 diff --git a/assets/img/landing_pages/create.png b/assets/img/landing_pages/create.png index d5f5f49a5a5..13864b06738 100644 Binary files a/assets/img/landing_pages/create.png and b/assets/img/landing_pages/create.png differ diff --git a/assets/img/landing_pages/dnd.png b/assets/img/landing_pages/dnd.png index b893919d317..77c9f8a69f6 100644 Binary files a/assets/img/landing_pages/dnd.png and b/assets/img/landing_pages/dnd.png differ diff --git a/assets/img/landing_pages/form.png b/assets/img/landing_pages/form.png index 9148b6a0269..ee4e2d88fde 100644 Binary files a/assets/img/landing_pages/form.png and b/assets/img/landing_pages/form.png differ diff --git a/assets/img/landing_pages/template.png b/assets/img/landing_pages/template.png index 4cb5efeea4d..a7e34ce347d 100644 Binary files a/assets/img/landing_pages/template.png and b/assets/img/landing_pages/template.png differ diff --git a/assets/img/landing_pages/url_handle.png b/assets/img/landing_pages/url_handle.png index e3b7beb7759..a8151b88dd1 100644 Binary files a/assets/img/landing_pages/url_handle.png and b/assets/img/landing_pages/url_handle.png differ diff --git a/assets/img/line/csv_export_user_data.png b/assets/img/line/csv_export_user_data.png new file mode 100644 index 00000000000..e849e0f7cdb Binary files /dev/null and b/assets/img/line/csv_export_user_data.png differ diff --git a/assets/img/line/filter_group.png b/assets/img/line/filter_group.png new file mode 100644 index 00000000000..c6cd1baca53 Binary files /dev/null and b/assets/img/line/filter_group.png differ diff --git a/assets/img/line/integration.png b/assets/img/line/integration.png new file mode 100644 index 00000000000..5661df3f994 Binary files /dev/null and b/assets/img/line/integration.png differ diff --git a/assets/img/line/line_composer.png b/assets/img/line/line_composer.png new file mode 100644 index 00000000000..3a9a2f82c3b Binary files /dev/null and b/assets/img/line/line_composer.png differ diff --git a/assets/img/line/line_performance.png b/assets/img/line/line_performance.png new file mode 100644 index 00000000000..e60cc581beb Binary files /dev/null and b/assets/img/line/line_performance.png differ diff --git a/assets/img/line/line_subscription_groups.png b/assets/img/line/line_subscription_groups.png new file mode 100644 index 00000000000..eab5e2ef7ee Binary files /dev/null and b/assets/img/line/line_subscription_groups.png differ diff --git a/assets/img/line/message.png b/assets/img/line/message.png new file mode 100644 index 00000000000..d45b14dd42a Binary files /dev/null and b/assets/img/line/message.png differ diff --git a/assets/img/line/response_settings.png b/assets/img/line/response_settings.png new file mode 100644 index 00000000000..e1aedd769f6 Binary files /dev/null and b/assets/img/line/response_settings.png differ diff --git a/assets/img/line/test_preview.png b/assets/img/line/test_preview.png new file mode 100644 index 00000000000..8b5c74e5f72 Binary files /dev/null and b/assets/img/line/test_preview.png differ diff --git a/assets/img/line/trigger.png b/assets/img/line/trigger.png new file mode 100644 index 00000000000..9fe02361126 Binary files /dev/null and b/assets/img/line/trigger.png differ diff --git a/assets/img/line/trigger_word_campaign.png b/assets/img/line/trigger_word_campaign.png new file mode 100644 index 00000000000..839db26791d Binary files /dev/null and b/assets/img/line/trigger_word_campaign.png differ diff --git a/assets/img/line/trigger_word_canvas.png b/assets/img/line/trigger_word_canvas.png new file mode 100644 index 00000000000..104f4a27def Binary files /dev/null and b/assets/img/line/trigger_word_canvas.png differ diff --git a/assets/img/line/webhook_settings.png b/assets/img/line/webhook_settings.png new file mode 100644 index 00000000000..287c6a6f6b4 Binary files /dev/null and b/assets/img/line/webhook_settings.png differ diff --git a/assets/js/feedback.js b/assets/js/feedback.js index 57157efa6b3..831edd7e4a6 100644 --- a/assets/js/feedback.js +++ b/assets/js/feedback.js @@ -5,6 +5,8 @@ $(document).ready(function(){ var feedback_config = { dest: 'https://c9616da7-4322-4bed-9b51-917c1874fb31.trayapp.io/feedback', site: feedback_site, + article_title: feedback_article_title, + nav_title: feedback_nav_title, params: null, helpful: '', postdate: null, @@ -36,10 +38,23 @@ $(document).ready(function(){ $('#feedback_answer').fadeOut("slow"); if (typeof (appboy) !== 'undefined') { - appboy.logCustomEvent("Documentations Feedback", {"Feedback": helpful,"URL": feedback_config['site']}); + appboy.logCustomEvent( + "Documentations Feedback", { + "Feedback": helpful, + "Article Title": feedback_config['article_title'], + "Nav Title": feedback_config['nav_title'], + "URL": feedback_config['site'] + } + ) } - var submit_data = {'Helpful': helpful,'URL':feedback_config['site'],'Params':window.location.search}; + var submit_data = { + 'Helpful': helpful, + 'URL':feedback_config['site'], + 'Article Title': feedback_config['article_title'], + 'Nav Title': feedback_config['nav_title'], + 'Params':window.location.search + }; var jqxhr = $.ajax({ url: feedback_config['dest'], method: "GET", @@ -76,9 +91,26 @@ $(document).ready(function(){ $('#feedback_submit_button').on('click',function(e){ $('#feedback_comment_div').fadeOut('slow'); - var submit_data = {'Helpful': feedback_config['helpful'],'URL':feedback_config['site'],'Params': feedback_config['params'],'ID': feedback_config['ID'],'postdate':feedback_config['postdate'],'Feedback':$('#feedback_comment').val()}; + var submit_data = { + 'Helpful': feedback_config['helpful'], + 'URL':feedback_config['site'], + 'Article Title': feedback_config['article_title'], + 'Nav Title': feedback_config['nav_title'], + 'Params': feedback_config['params'], + 'ID': feedback_config['ID'], + 'postdate':feedback_config['postdate'], + 'Feedback':$('#feedback_comment').val() + }; if (typeof (appboy) !== 'undefined') { - appboy.logCustomEvent("Documentations Feedback Comment", {"Feedback": feedback_config['helpful'],"URL": feedback_config['site'],"Comment": $('#feedback_comment').val()}); + appboy.logCustomEvent( + "Documentations Feedback Comment", { + "Feedback": feedback_config['helpful'], + "Article Title": feedback_config['article_title'], + "Nav Title": feedback_config['nav_title'], + "URL": feedback_config['site'], + "Comment": $('#feedback_comment').val() + } + ); } var jqxhr = $.ajax({ url: feedback_config['dest'] + '/comment',