Skip to main content
Version: 1.3.0

User Signup Event

A custom Braze event for a user signup.

Code Example

braze.logCustomEvent("user_signup", {
"signup_method": "email",
"signup_source": "homepage"
});

Event Properties

PropertyTypeConstraintsExamplesDescription
eventstringrequired
"user_signup"
The custom event name for a completed signup.
const: "user_signup"
signup_methodstringenum: [email, google, apple]
"email"
"google"
The method the user used to sign up.
signup_sourcestring
"homepage"
"checkout"
The surface that started the signup.
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/user-signup-event.json",
  "title": "User Signup Event",
  "description": "A custom Braze event for a user signup.",
  "x-tracking-targets": [
    "web-braze-js"
  ],
  "x-method": "track",
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "const": "user_signup",
      "description": "The custom event name for a completed signup."
    },
    "signup_method": {
      "type": "string",
      "description": "The method the user used to sign up.",
      "enum": [
        "email",
        "google",
        "apple"
      ],
      "examples": [
        "email",
        "google"
      ]
    },
    "signup_source": {
      "type": "string",
      "description": "The surface that started the signup.",
      "examples": [
        "homepage",
        "checkout"
      ]
    }
  },
  "required": [
    "event"
  ]
}