Braze JavaScript SDK
    Preparing search index...

    Function logCustomEvent

    • Reports that the current user performed a custom named event.

      Parameters

      • eventName: string

        The identifier for the event to track. Value is limited to 255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation.

      • OptionaleventProperties: GenericObject

        Hash of properties for this event. Keys are limited to 255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation. Values can be numeric, boolean, Date objects, strings 255 characters or shorter, or nested objects whose values can be numeric, boolean, Date objects, arrays, strings, or null. Total size of event properties cannot exceed 50KB.

      Returns Promise<boolean | undefined>

      Resolves to a boolean that indicates whether the event was successfully enqueued. Resolves to undefined if the SDK is not initialized.