Newsletter Subscribed Event

A custom Braze event for a newsletter subscription.

Code Example

braze.logCustomEvent("newsletter_subscribed", {
  "newsletter_name": "weekly_deals",
  "subscription_channel": "email",
  "source": "footer_form"
});

Event Properties

Property	Type	Constraints	Examples	Description
event	string	required	"newsletter_subscribed"	The custom event name for a newsletter subscription.
		const: "newsletter_subscribed"
newsletter_name	string		"weekly_deals" "product_updates"	The newsletter the user subscribed to.
subscription_channel	string	enum: [email, sms]	"email"	The channel used for the subscription.
source	string		"footer_form" "checkout_opt_in"	The surface that collected the subscription.

View Raw JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://tracking-docs-demo.buchert.digital/schemas/1.3.0/braze/newsletter-subscribed-event.json",
  "title": "Newsletter Subscribed Event",
  "description": "A custom Braze event for a newsletter subscription.",
  "x-tracking-targets": [
    "web-braze-js"
  ],
  "x-method": "track",
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "const": "newsletter_subscribed",
      "description": "The custom event name for a newsletter subscription."
    },
    "newsletter_name": {
      "type": "string",
      "description": "The newsletter the user subscribed to.",
      "examples": [
        "weekly_deals",
        "product_updates"
      ]
    },
    "subscription_channel": {
      "type": "string",
      "description": "The channel used for the subscription.",
      "enum": [
        "email",
        "sms"
      ],
      "examples": [
        "email"
      ]
    },
    "source": {
      "type": "string",
      "description": "The surface that collected the subscription.",
      "examples": [
        "footer_form",
        "checkout_opt_in"
      ]
    }
  },
  "required": [
    "event"
  ]
}