docs
  1. Webhooks
  2. Customer Events
  3. Newsletter-subscribed

newsletter-subscribed

A newsletter-subscribed event is triggered when a customer subscribes to a newsletter.

Example:

Properties:

  • key string
  • meta object
    • xRequestId string
  • occuredAt string
  • type enum
  • payload object
    • channel string (email)
    • customer object
      • id string (optional)
      • referenceKey string (optional) (min length: 1, max length: 100)
      • firstName string (optional)
      • lastName string
      • gender enum (m f d n) (optional)
      • birthDate string (date ISO 8601) (optional)
      • email string (optional)
      • phone string (optional)
      • publicKey string (optional) (min length: 1, max length: 100)
      • title string (optional) (maximum length: 30)
      • type string
      • groups array<string> (optional)
      • identities array (optional)
        • externalUserId string (optional)
        • identityProviderCode string (optional)
      • createdAt string (date-time ISO 8601)(optional)
      • updatedAt string (date-time ISO 8601) (optional)
      • status object
        • isActive boolean
        • isGuestCustomer boolean
      • company
        • id string
        • name string
    • text string (optional)
    • shopCountry object
      • id integer
      • shopKey string (exact length: 2) (optional)
      • countryCode string (exact length: 2) (optional)
      • defaultLanguageCode string (maximum length: 5)
      • supportedLanguageCodes array<string> (optional) (maximum length of an array item: 5)
      • priceGroupKey string (optional)
      • smartSortingKey string (optional)
      • url string (optional)
      • active boolean
      • currencyCode string (optional)
      • deleted boolean