Events

Events for Almeta Cloud are similar to events for Google Analytics, Facebook Ads, Bing Ads, etc. You run small pieces of code to track corresponding actions, and you have an option to add additional information. Most of the event parameters are optional.

We recommend using the standard events when possible, but you can also create custom events by adding custom: prefix to the event name. For example, custom:my_event.

add_to_cart Event

Triggered when a user adds an item to their shopping cart.

Parameter	Required?	Format	Description
name	Required	String	Event name 'add_to_cart'
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'add_to_cart',
  data: {
    currency: 'USD',
    value: 49.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

add_to_list Event

Triggered when a user adds an item to a list (e.g., wishlist, favorites, etc.).

Parameter	Required?	Format	Description
name	Required	String	Event name 'add_to_list'
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.list_id	Optional	String or Number	List ID

_almeta.t('event', {
  name: 'add_to_list',
  data: {
    currency: 'USD',
    value: 49.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    list_id: 'wishlist-123'
  }
})

add_review Event

Triggered when a user adds a review for a product or service.

Parameter	Required?	Format	Description
name	Required	String	Event name 'add_review'
data.subject_id	Required	String or Number	Subject ID (e.g., product ID, service ID)
data.subject_type	Optional	String	Subject type (e.g., product, service)
data.subject_name	Optional	String	Subject name
data.rating	Optional	Number	Review rating (1-5)

_almeta.t('event', {
  name: 'add_review',
  data: {
    subject_id: 'SKU-12345',
    subject_type: 'product',
    subject_name: 'Product Name',
    rating: 4
  }
})

add_payment_info Event

Triggered when a user adds payment information during the checkout process.

Parameter	Required?	Format	Description
name	Required	String	Event name 'add_payment_info'
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.payment_type	Optional	String or Number	Payment type (e.g., visa, apple pay)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.promotions	Optional	Array of Objects	Array of promotions applied to the transaction. Each promotion object should have the following properties:
		id (Optional, String)	Promotion ID
		name (Optional, String)	Promotion name
		type (Optional, String)	Promotion type (e.g., discount_code, buy_one_get_one, etc.)
		coupon (Optional, String)	Coupon code associated with the promotion
		discount (Optional, Number)	Discount value

_almeta.t('event', {
  name: 'add_payment_info',
  data: {
    currency: 'USD',
    value: 99.99,
    payment_type: 'visa',
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    promotions: [
      {
        id: 'PROMO-DEF',
        name: 'Free Shipping',
        type: 'free_shipping'
      }
    ]
  }
})

add_shipping_info Event

Triggered when a user adds shipping information during the checkout process.

Parameter	Required?	Format	Description
name	Required	String	Event name 'add_shipping_info'
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.shipping_tier	Optional	String or Number	Shipping tier (e.g., ground, next day)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.promotions	Optional	Array of Objects	Array of promotions applied to the transaction. Each promotion object should have the following properties:
		id (Optional, String)	Promotion ID
		name (Optional, String)	Promotion name
		type (Optional, String)	Promotion type (e.g., discount_code, buy_one_get_one, etc.)
		coupon (Optional, String)	Coupon code associated with the promotion
		discount (Optional, Number)	Discount value

_almeta.t('event', {
  name: 'add_shipping_info',
  data: {
    currency: 'USD',
    value: 99.99,
    shipping_tier: 'ground',
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    promotions: [
      {
        id: 'PROMO-DEF',
        name: 'Free Shipping',
        type: 'free_shipping'
      }
    ]
  }
})

add_user Event

Triggered when a user is added to a group account.

Parameter	Required?	Format	Description
name	Required	String	Event name 'add_user'
data.group_id	Optional	String or Number	Group or cohort ID

_almeta.t('event', {
  name: 'add_user',
  data: {
    group_id: 'authors'
  }
})

apply_collection_filters Event

Triggered when filters are applied to a collection or product list.

Parameter	Required?	Format	Description
name	Required	String	Event name 'apply_collection_filters'
data.collection_id	Required	String or Number	Collection or product list ID
data.collection_name	Optional	String	Name of the collection or product list
data.filter_id	Optional	String or Number	ID of the applied filter
data.filter_values	Optional	Array of Strings	Array of filter values
data.items_count	Optional	Number	Number of items in the filtered collection

_almeta.t('event', {
  name: 'apply_collection_filters',
  data: {
    collection_id: 'collection-abc',
    collection_name: 'Summer Collection',
    filter_id: 'color',
    filter_values: ['red', 'blue'],
    items_count: 25
  }
})

apply_promotion Event

Triggered when a promotion is applied to a transaction or order.

Parameter	Required?	Format	Description
name	Required	String	Event name 'apply_promotion'
data.promotion	Optional	Array of Objects	Array of promotion details. Each object in the array should have the following properties:
		id (Optional, String)	Promotion ID
		name (Optional, String)	Promotion name
		type (Optional, String)	Promotion type (e.g., discount_code, buy_one_get_one, etc.)
		coupon (Optional, String)	Coupon code associated with the promotion
		discount (Optional, Number)	Discount value

_almeta.t('event', {
  name: 'apply_promotion',
  data: {
    promotion: [
      {
        id: 'PROMO-ABC',
        name: 'Spring Sale',
        type: 'discount_code',
        coupon: 'SPRING2023',
        discount: 10.0
      }
    ]
  }
})

cancel_order Event

Triggered when an order is canceled.

Parameter	Required?	Format	Description
name	Required	String	Event name 'cancel_order'
data.transaction_id	Required	String or Number	Transaction or order ID
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'cancel_order',
  data: {
    transaction_id: 'ORDER-12345',
    currency: 'USD',
    value: 99.99,
    tax: 5.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

cancel_plan Event

Triggered when a subscription plan is canceled.

Parameter	Required?	Format	Description
name	Required	String	Event name 'cancel_plan'
data.plan	Optional	String or Number	Subscription plan name or ID

_almeta.t('event', {
  name: 'cancel_plan',
  data: {
    plan: 'monthly-subscription'
  }
})

cancel_return Event

Triggered when a return is canceled.

Parameter	Required?	Format	Description
name	Required	String	Event name 'cancel_return'
data.transaction_id	Required	String or Number	Transaction or order ID
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.return_shipping	Optional	Number	Return shipping cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'cancel_return',
  data: {
    transaction_id: 'RETURN-12345',
    currency: 'USD',
    value: 49.99,
    tax: 2.99,
    return_shipping: 5.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

cancel_tutorial Event

Triggered when a tutorial is canceled.

Parameter	Required?	Format	Description
name	Required	String	Event name 'cancel_tutorial'
data.tutorial	Optional	String or Number	Tutorial name or ID

_almeta.t('event', {
  name: 'cancel_tutorial',
  data: {
    tutorial: 'getting-started'
  }
})

change_plan Event

Triggered when a subscription plan is changed.

Parameter	Required?	Format	Description
name	Required	String	Event name 'change_plan'
data.new_plan	Optional	String or Number	New subscription plan name or ID
data.old_plan	Optional	String or Number	Old subscription plan name or ID

_almeta.t('event', {
  name: 'change_plan',
  data: {
    new_plan: 'premium-monthly',
    old_plan: 'basic-monthly'
  }
})

chargeback Event

Triggered when a chargeback occurs.

Parameter	Required?	Format	Description
name	Required	String	Event name 'chargeback'
data.reason	Optional	String or Number	Chargeback reason
data.transaction_id	Required	String or Number	Transaction or order ID
data.currency	Required	String	3-letter ISO 4217 currency code
data.value	Required	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'chargeback',
  data: {
    reason: 'unauthorized',
    transaction_id: 'ORDER-12345',
    currency: 'USD',
    value: 99.99,
    tax: 5.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

click_cta Event

Triggered when a user clicks on a call-to-action (CTA) element.

Parameter	Required?	Format	Description
name	Required	String	Event name 'click_cta'
data.id	Optional	String or Number	CTA ID

_almeta.t('event', {
  name: 'click_cta',
  data: {
    id: 'cta-signup-button'
  }
})

close_live_chat Event

Triggered when a live chat session is closed.

Parameter	Required?	Format	Description
name	Required	String	Event name 'close_live_chat'

_almeta.t('event', {
  name: 'close_live_chat',
})

complete_return Event

Triggered when a return is completed.

Parameter	Required?	Format	Description
name	Required	String	Event name 'complete_return'
data.transaction_id	Required	String or Number	Transaction or order ID
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.return_shipping	Optional	Number	Return shipping cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'complete_return',
  data: {
    transaction_id: 'RETURN-12345',
    currency: 'USD',
    value: 49.99,
    tax: 2.99,
    return_shipping: 5.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

complete_tutorial Event

Triggered when a tutorial is completed.

Parameter	Required?	Format	Description
name	Required	String	Event name 'complete_tutorial'
data.tutorial	Optional	String or Number	Tutorial name or ID

_almeta.t('event', {
  name: 'complete_tutorial',
  data: {
    tutorial: 'getting-started'
  }
})

contact Event

Triggered when a user submits a contact form.

Parameter	Required?	Format	Description
name	Required	String	Event name 'contact'
data.form	Optional	String or Number	Contact form ID

_almeta.t('event', {
  name: 'contact',
  data: {
    form: 'contact-form-main'
  }
})

custom Event

Triggered for custom events defined by the user.

Parameter	Required?	Format	Description
name	Required	String	Custom event name (must start with 'custom:')
data	Optional	Object	Custom event data in JSON format

_almeta.t('event', {
  name: 'custom:my_custom_event',
  data: {
    custom_field_1: 'value1',
    custom_field_2: 'value2'
  }
})

customize_product Event

Triggered when a user customizes a product.

Parameter	Required?	Format	Description
name	Required	String	Event name 'customize_product'
data.id	Required	String or Number	Product ID
data.brand	Optional	String	Product brand
data.name	Optional	String	Product name
data.variant	Optional	String or Number	Product variant
data.customization	Optional	String	Product customization details

_almeta.t('event', {
  name: 'customize_product',
  data: {
    id: 'SKU-12345',
    brand: 'Brand Name',
    name: 'Product Name',
    variant: 'Variant Details',
    customization: 'Custom engraving: "Happy Birthday"'
  }
})

deny_promotion Event

Triggered when a promotion is denied or rejected.

Parameter	Required?	Format	Description
name	Required	String	Event name 'deny_promotion'
data.promotion	Optional	Array of Objects	Array of promotion details. Each object in the array should have the following properties:
		id (Optional, String)	Promotion ID
		name (Optional, String)	Promotion name
		type (Optional, String)	Promotion type (e.g., discount_code, buy_one_get_one, etc.)
		coupon (Optional, String)	Coupon code associated with the promotion
		discount (Optional, Number)	Discount value
data.reason	Optional	String or Number	Reason for denying the promotion

_almeta.t('event', {
  name: 'deny_promotion',
  data: {
    promotion: [
      {
        id: 'PROMO-ABC',
        name: 'Expired Promotion',
        type: 'discount_code',
        coupon: 'EXPIRED2022',
        discount: 10.0
      }
    ],
    reason: 'The promotion has expired'
  }
})

donate Event

Triggered when a user makes a donation.

Parameter	Required?	Format	Description
name	Required	String	Event name 'donate'
data.transaction_id	Required	String or Number	Transaction or donation ID
data.currency	Required	String	3-letter ISO 4217 currency code
data.value	Required	Number	Total monetary value of the donation
data.tax	Optional	Number	Tax cost (if applicable)
data.items	Optional	Array of Objects	Array of donated items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'donate',
  data: {
    transaction_id: 'DONATION-12345',
    currency: 'USD',
    value: 50.0,
    tax: 0,
    items: [
      {
        id: 'ITEM-12345',
        name: 'Donation Item',
        price: 50.0,
        quantity: 1
      }
    ]
  }
})

email_bounce Event

Triggered when an email message bounces.

Parameter	Required?	Format	Description
name	Required	String	Event name 'email_bounce'
data.message_id	Optional	String or Number	ID of the bounced email message
data.list_id	Optional	String or Number	ID of the email list
data.type	Optional	String	Bounce type: 'soft', 'hard', or 'error'
data.reason	Optional	String or Number	Reason for the bounce

_almeta.t('event', {
  name: 'email_bounce',
  data: {
    message_id: 'MESSAGE-12345',
    list_id: 'LIST-54321',
    type: 'soft',
    reason: 'Mailbox temporarily unavailable'
  }
})

email_click Event

Triggered when a user clicks on a link in an email message.

Parameter	Required?	Format	Description
name	Required	String	Event name 'email_click'
data.message_id	Optional	String or Number	ID of the email message
data.list_id	Optional	String or Number	ID of the email list
data.link_id	Optional	String or Number	ID of the clicked link

_almeta.t('event', {
  name: 'email_click',
  data: {
    message_id: 'MESSAGE-12345',
    list_id: 'LIST-54321',
    link_id: 'LINK-98765'
  }
})

email_complaint Event

Triggered when a user marks an email message as spam or submits a complaint.

Parameter	Required?	Format	Description
name	Required	String	Event name 'email_complaint'
data.message_id	Optional	String or Number	ID of the email message
data.list_id	Optional	String or Number	ID of the email list
data.type	Optional	String or Number	Type of complaint

_almeta.t('event', {
  name: 'email_complaint',
  data: {
    message_id: 'MESSAGE-12345',
    list_id: 'LIST-54321',
    type: 'spam'
  }
})

email_open Event

Triggered when a user opens an email message.

Parameter	Required?	Format	Description
name	Required	String	Event name 'email_open'
data.message_id	Optional	String or Number	ID of the email message
data.list_id	Optional	String or Number	ID of the email list

_almeta.t('event', {
  name: 'email_open',
  data: {
    message_id: 'MESSAGE-12345',
    list_id: 'LIST-54321'
  }
})

email_send Event

Triggered when an email message is sent.

Parameter	Required?	Format	Description
name	Required	String	Event name 'email_send'
data.message_id	Optional	String or Number	ID of the email message
data.type	Optional	String or Number	Type of email (e.g., transactional, marketing)
data.list_id	Optional	String or Number	ID of the email list

_almeta.t('event', {
  name: 'email_send',
  data: {
    message_id: 'MESSAGE-12345',
    type: 'marketing',
    list_id: 'LIST-54321'
  }
})

end_trial Event

Triggered when a user's trial period ends.

Parameter	Required?	Format	Description
name	Required	String	Event name 'end_trial'
data.id	Optional	String or Number	ID of the trial

_almeta.t('event', {
  name: 'end_trial',
  data: {
    id: 'TRIAL-12345'
  }
})

error Event

Triggered when an error occurs.

Parameter	Required?	Format	Description
name	Required	String	Event name 'error'
data.code	Optional	String or Number	Error code
data.text	Optional	String	Error text or message

_almeta.t('event', {
  name: 'error',
  data: {
    code: 'ERR-500',
    text: 'Internal Server Error'
  }
})

fraud_risk Event

Triggered when a fraud risk is detected.

Parameter	Required?	Format	Description
name	Required	String	Event name 'fraud_risk'
data.risk	Optional	String or Number	Fraud risk value

_almeta.t('event', {
  name: 'fraud_risk',
  data: {
    risk: 'high'
  }
})

hide_ad Event

Triggered when a user hides an advertisement.

Parameter	Required?	Format	Description
name	Required	String	Event name 'hide_ad'
data.id	Required	String or Number	Advertisement ID (could be a URL)
data.name	Optional	String	Advertisement name
data.reason	Optional	String or Number	Reason for hiding the advertisement (e.g., irrelevant, repetitive)

_almeta.t('event', {
  name: 'hide_ad',
  data: {
    id: 'AD-12345',
    name: 'Summer Sale',
    reason: 'irrelevant'
  }
})

interact_with_ad Event

Triggered when a user interacts with an advertisement (e.g., clicks, likes, comments).

Parameter	Required?	Format	Description
name	Required	String	Event name 'interact_with_ad'
data.id	Required	String or Number	Advertisement ID (could be a URL)
data.name	Optional	String	Advertisement name
data.type	Optional	String or Number	Type of interaction (e.g., click, like, comment)

_almeta.t('event', {
  name: 'interact_with_ad',
  data: {
    id: 'AD-12345',
    name: 'Summer Sale',
    type: 'click'
  }
})

leave_page Event

Triggered when a user leaves a page.

Parameter	Required?	Format	Description
name	Required	String	Event name 'leave_page'
data.id	Required	String	Page URL
data.type	Optional	String	Page type (e.g., product, collection)
data.name	Optional	String	Page name

_almeta.t('event', {
  name: 'leave_page',
  data: {
    id: 'https://example.com/products/123',
    type: 'product',
    name: 'Product Name'
  }
})

login Event

Triggered when a user logs in.

Parameter	Required?	Format	Description
name	Required	String	Event name 'login'
data.method	Optional	String	Login method (e.g., email, google)

_almeta.t('event', {
  name: 'login',
  data: {
    method: 'email'
  }
})

logout Event

Triggered when a user logs out.

Parameter	Required?	Format	Description
name	Required	String	Event name 'logout'

_almeta.t('event', {
  name: 'logout'
})

new_lead Event

Triggered when a new lead is generated.

Parameter	Required?	Format	Description
name	Required	String	Event name 'new_lead'
data.type	Optional	String or Number	Type of lead

_almeta.t('event', {
  name: 'new_lead',
  data: {
    type: 'newsletter'
  }
})

pause_video Event

Triggered when a video is paused.

Parameter	Required?	Format	Description
name	Required	String	Event name 'pause_video'
data.id	Required	String or Number	Video ID (could be a URL)
data.name	Optional	String	Video name
data.seek_position	Optional	Number	Current seek position in seconds

_almeta.t('event', {
  name: 'pause_video',
  data: {
    id: 'VIDEO-12345',
    name: 'Product Demo',
    seek_position: 30
  }
})

play_video Event

Triggered when a video starts playing.

Parameter	Required?	Format	Description
name	Required	String	Event name 'play_video'
data.id	Required	String or Number	Video ID (could be a URL)
data.name	Optional	String	Video name
data.seek_position	Optional	Number	Current seek position in seconds

_almeta.t('event', {
  name: 'play_video',
  data: {
    id: 'VIDEO-12345',
    name: 'Product Demo',
    seek_position: 0
  }
})

post_content Event

Triggered when a user posts content (e.g., a comment, review, or user-generated content).

Parameter	Required?	Format	Description
name	Required	String	Event name 'post_content'
data.id	Required	String or Number	Content ID (could be a URL)
data.type	Optional	String	Content type (e.g., product, page)
data.name	Optional	String	Content name

_almeta.t('event', {
  name: 'post_content',
  data: {
    id: 'CONTENT-12345',
    type: 'comment',
    name: 'Product Review'
  }
})

purchase Event

Triggered when a user completes a purchase.

Parameter	Required?	Format	Description
name	Required	String	Event name 'purchase'
data.transaction_id	Required	String or Number	Transaction ID
data.currency	Required	String	Transaction currency in 3-letter ISO 4217 format
data.value	Required	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.shipping	Optional	Number	Shipping cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.promotions	Optional	Array of Objects	Array of promotions applied to the transaction. Each promotion object should have the same properties as the promotions property within the items array.
data.discount	Optional	Number	Total discount value

_almeta.t('event', {
  name: 'purchase',
  data: {
    transaction_id: 'ORDER-12345',
    currency: 'USD',
    value: 99.99,
    tax: 5.99,
    shipping: 7.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    promotions: [
      {
        id: 'PROMO-DEF',
        name: 'Free Shipping',
        type: 'free_shipping'
      }
    ],
    discount: 10.0
  }
})

push_click Event

Triggered when a user clicks on a push notification.

Parameter	Required?	Format	Description
name	Required	String	Event name 'push_click'
data.message_id	Optional	String or Number	ID of the push notification message
data.list_id	Optional	String or Number	ID of the push notification list
data.link_id	Optional	String or Number	ID of the clicked link within the push notification

_almeta.t('event', {
  name: 'push_click',
  data: {
    message_id: 'PUSH-12345',
    list_id: 'LIST-54321',
    link_id: 'LINK-98765'
  }
})

push_error Event

Triggered when an error occurs while sending a push notification.

Parameter	Required?	Format	Description
name	Required	String	Event name 'push_error'
data.message_id	Optional	String or Number	ID of the push notification message
data.list_id	Optional	String or Number	ID of the push notification list
data.code	Optional	String or Number	Error code
data.text	Optional	String	Error text or message

_almeta.t('event', {
  name: 'push_error',
  data: {
    message_id: 'PUSH-12345',
    list_id: 'LIST-54321',
    code: 'ERR-500',
    text: 'Internal Server Error'
  }
})

push_send Event

Triggered when a push notification is sent.

Parameter	Required?	Format	Description
name	Required	String	Event name 'push_send'
data.message_id	Optional	String or Number	ID of the push notification message
data.type	Optional	String or Number	Type of push notification (e.g., transactional, marketing)
data.list_id	Optional	String or Number	ID of the push notification list

_almeta.t('event', {
  name: 'push_send',
  data: {
    message_id: 'PUSH-12345',
    type: 'marketing',
    list_id: 'LIST-54321'
  }
})

refund Event

Triggered when a refund is processed.

Parameter	Required?	Format	Description
name	Required	String	Event name 'refund'
data.transaction_id	Required	String or Number	Transaction ID
data.currency	Optional	String	Transaction currency in 3-letter ISO 4217 format
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'refund',
  data: {
    transaction_id: 'ORDER-12345',
    currency: 'USD',
    value: 49.99,
    tax: 2.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

remove_from_cart Event

Triggered when a user removes an item from their shopping cart.

Parameter	Required?	Format	Description
name	Required	String	Event name 'remove_from_cart'
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'remove_from_cart',
  data: {
    currency: 'USD',
    value: 49.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

remove_from_list Event

Triggered when a user removes an item from a list (e.g., wishlist, favorites, etc.).

Parameter	Required?	Format	Description
name	Required	String	Event name 'remove_from_list'
data.currency	Optional	String	3-letter ISO 4217 currency code
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.list_id	Optional	String or Number	List ID

_almeta.t('event', {
  name: 'remove_from_list',
  data: {
    currency: 'USD',
    value: 49.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    list_id: 'wishlist-123'
  }
})

remove_promotion Event

Triggered when a promotion is removed from a transaction or order.

Parameter	Required?	Format	Description
name	Required	String	Event name 'remove_promotion'
data.promotion	Optional	Array of Objects	Array of promotion details. Each object in the array should have the following properties:
		id (Optional, String)	Promotion ID
		name (Optional, String)	Promotion name
		type (Optional, String)	Promotion type (e.g., discount_code, buy_one_get_one, etc.)
		coupon (Optional, String)	Coupon code associated with the promotion
		discount (Optional, Number)	Discount value

_almeta.t('event', {
  name: 'remove_promotion',
  data: {
    promotion: [
      {
        id: 'PROMO-ABC',
        name: 'Spring Sale',
        type: 'discount_code',
        coupon: 'SPRING2023',
        discount: 10.0
      }
    ]
  }
})

remove_user Event

Triggered when a user is removed from a group.

Parameter	Required?	Format	Description
name	Required	String	Event name 'remove_user'
data.group_id	Optional	String or Number	Group or cohort ID

_almeta.t('event', {
  name: 'remove_user',
  data: {
    group_id: 'authors'
  }
})

reset_password Event

Triggered when a user resets their password.

Parameter	Required?	Format	Description
name	Required	String	Event name 'reset_password'
data	Optional	Object	Additional data related to the password reset event

_almeta.t('event', {
  name: 'reset_password'
})

schedule Event

Triggered when a user schedules an appointment or event.

Parameter	Required?	Format	Description
name	Required	String	Event name 'schedule'
data.type	Optional	String or Number	Type of schedule (e.g., appointment, meeting, event)

_almeta.t('event', {
  name: 'schedule',
  data: {
    type: 'appointment'
  }
})

scroll_to_content Event

Triggered when a user scrolls to a specific content section on a page.

Parameter	Required?	Format	Description
name	Required	String	Event name 'scroll_to_content'
data.id	Required	String or Number	Content ID
data.type	Optional	String	Content type (e.g., product description, faq)
data.name	Optional	String	Content name

_almeta.t('event', {
  name: 'scroll_to_content',
  data: {
    id: 'product-description',
    type: 'product_description',
    name: 'Product Details'
  }
})

search Event

Triggered when a user performs a search.

Parameter	Required?	Format	Description
name	Required	String	Event name 'search'
data.query	Optional	String	Search query
data.results_count	Optional	Number	Number of search results

_almeta.t('event', {
  name: 'search',
  data: {
    query: 'blue shoes',
    results_count: 25
  }
})

search_locations Event

Triggered when a user searches for locations (like stores, offices, etc).

Parameter	Required?	Format	Description
name	Required	String	Event name 'search_locations'
data.locations	Optional	Array of Strings or Numbers	List of searched locations

_almeta.t('event', {
  name: 'search_locations',
  data: {
    locations: ['Retail store #1', 'Retail store #2', 'Retail store #3']
  }
})

select_location Event

Triggered when a user selects a location.

Parameter	Required?	Format	Description
name	Required	String	Event name 'select_location'
data.location_id	Optional	String or Number	Location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'select_location',
  data: {
    location_id: 'store-123'
  }
})

select_plan Event

Triggered when a user selects a subscription plan.

Parameter	Required?	Format	Description
name	Required	String	Event name 'select_plan'
data.plan	Optional	String or Number	Subscription plan name or ID

_almeta.t('event', {
  name: 'select_plan',
  data: {
    plan: 'premium-monthly'
  }
})

select_variant Event

Triggered when a user selects a product variant.

Parameter	Required?	Format	Description
name	Required	String	Event name 'select_variant'
data.id	Required	String or Number	Product ID
data.brand	Optional	String	Product brand
data.name	Optional	String	Product name
data.variant	Optional	String or Number	Product variant

_almeta.t('event', {
  name: 'select_variant',
  data: {
    id: 'SKU-12345',
    brand: 'Brand Name',
    name: 'Product Name',
    variant: 'Red'
  }
})

send_live_chat Event

Triggered when a user sends a message in a live chat session.

Parameter	Required?	Format	Description
name	Required	String	Event name 'send_live_chat'
data.content_id	Optional	String or Number	ID of the chat message content

_almeta.t('event', {
  name: 'send_live_chat',
  data: {
    content_id: 'MSG-12345'
  }
})

share Event

Triggered when a user shares content.

Parameter	Required?	Format	Description
name	Required	String	Event name 'share'
data.id	Required	String or Number	Content ID (could be a URL)
data.type	Optional	String	Content type (e.g., product, page)
data.name	Optional	String	Content name
data.destination	Optional	String	Sharing destination (e.g., email, instagram)

_almeta.t('event', {
  name: 'share',
  data: {
    id: 'https://example.com/products/123',
    type: 'product',
    name: 'Product Name',
    destination: 'facebook'
  }
})

shipment_update Event

Triggered when there is an update to a shipment.

Parameter	Required?	Format	Description
name	Required	String	Event name 'shipment_update'
data.transaction_id	Required	String or Number	Transaction or order ID
data.update	Required	String or Number	Update details
data.currency	Required	String	Transaction currency in 3-letter ISO 4217 format
data.value	Required	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'shipment_update',
  data: {
    transaction_id: 'ORDER-12345',
    update: 'Shipped',
    currency: 'USD',
    value: 99.99,
    tax: 5.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

signup Event

Triggered when a user signs up.

Parameter	Required?	Format	Description
name	Required	String	Event name 'signup'
data.method	Optional	String	Signup method (e.g., email, google)

_almeta.t('event', {
  name: 'signup',
  data: {
    method: 'email'
  }
})

sms_click Event

Triggered when a user clicks on a link in an SMS message.

Parameter	Required?	Format	Description
name	Required	String	Event name 'sms_click'
data.message_id	Optional	String or Number	ID of the SMS message
data.list_id	Optional	String or Number	ID of the SMS list
data.link_id	Optional	String or Number	ID of the clicked link

_almeta.t('event', {
  name: 'sms_click',
  data: {
    message_id: 'SMS-12345',
    list_id: 'LIST-54321',
    link_id: 'LINK-98765'
  }
})

sms_error Event

Triggered when an error occurs while sending an SMS message.

Parameter	Required?	Format	Description
name	Required	String	Event name 'sms_error'
data.message_id	Optional	String or Number	ID of the SMS message
data.list_id	Optional	String or Number	ID of the SMS list
data.code	Optional	String or Number	Error code
data.text	Optional	String	Error text or message

_almeta.t('event', {
  name: 'sms_error',
  data: {
    message_id: 'SMS-12345',
    list_id: 'LIST-54321',
    code: 'ERR-500',
    text: 'Internal Server Error'
  }
})

sms_send Event

Triggered when an SMS message is sent.

Parameter	Required?	Format	Description
name	Required	String	Event name 'sms_send'
data.message_id	Optional	String or Number	ID of the SMS message
data.type	Optional	String or Number	Type of SMS message (e.g., transactional, marketing)
data.list_id	Optional	String or Number	ID of the SMS list

_almeta.t('event', {
  name: 'sms_send',
  data: {
    message_id: 'SMS-12345',
    type: 'marketing',
    list_id: 'LIST-54321'
  }
})

start_checkout Event

Triggered when a user starts the checkout process.

Parameter	Required?	Format	Description
name	Required	String	Event name 'start_checkout'
data.currency	Optional	String	Transaction currency in 3-letter ISO 4217 format
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.promotions	Optional	Array of Objects	Array of promotions applied to the transaction. Each promotion object should have the same properties as the promotions property within the items array.

_almeta.t('event', {
  name: 'start_checkout',
  data: {
    currency: 'USD',
    value: 99.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    promotions: [
      {
        id: 'PROMO-DEF',
        name: 'Free Shipping',
        type: 'free_shipping'
      }
    ]
  }
})

start_live_chat Event

Triggered when a user starts a live chat session.

Parameter	Required?	Format	Description
name	Required	String	Event name 'start_live_chat'
data.content_id	Optional	String or Number	ID of the chat message content

_almeta.t('event', {
  name: 'start_live_chat',
  data: {
    content_id: 'MSG-12345'
  }
})

start_return Event

Triggered when a user initiates a return process.

Parameter	Required?	Format	Description
name	Required	String	Event name 'start_return'
data.transaction_id	Required	String or Number	Transaction or order ID
data.currency	Optional	String	Transaction currency in 3-letter ISO 4217 format
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.tax	Optional	Number	Tax cost
data.return_shipping	Optional	Number	Return shipping cost
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)

_almeta.t('event', {
  name: 'start_return',
  data: {
    transaction_id: 'RETURN-12345',
    currency: 'USD',
    value: 49.99,
    tax: 2.99,
    return_shipping: 5.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ]
  }
})

start_trial Event

Triggered when a user starts a trial.

Parameter	Required?	Format	Description
name	Required	String	Event name 'start_trial'
data.id	Optional	String or Number	ID of the trial

_almeta.t('event', {
  name: 'start_trial',
  data: {
    id: 'TRIAL-12345'
  }
})

start_tutorial Event

Triggered when a user starts a tutorial.

Parameter	Required?	Format	Description
name	Required	String	Event name 'start_tutorial'
data.tutorial	Optional	String or Number	Tutorial name or ID

_almeta.t('event', {
  name: 'start_tutorial',
  data: {
    tutorial: 'getting-started'
  }
})

submit_application Event

Triggered when a user submits an application.

Parameter	Required?	Format	Description
name	Required	String	Event name 'submit_application'
data.type	Optional	String or Number	Type of application

_almeta.t('event', {
  name: 'submit_application',
  data: {
    type: 'job-application'
  }
})

subscribe Event

Triggered when a user subscribes to a list or service.

Parameter	Required?	Format	Description
name	Required	String	Event name 'subscribe'
data.id	Optional	String or Number	Subscription or list ID

_almeta.t('event', {
  name: 'subscribe',
  data: {
    id: 'LIST-12345'
  }
})

tracking_consent Event

Triggered when a user provides their tracking consent preferences.

Parameter	Required?	Format	Description
name	Required	String	Event name 'tracking_consent'
data.accept_required	Optional	Boolean	Accept required cookies (always true)
data.accept_analytics	Required	Boolean	Accept analytics tracking
data.accept_marketing	Required	Boolean	Accept marketing tracking
data.accept_performance	Optional	Boolean	Accept performance tracking
data.accept_other	Optional	Boolean	Accept other tracking

_almeta.t('event', {
  name: 'tracking_consent',
  data: {
    accept_required: true,
    accept_analytics: true,
    accept_marketing: false,
    accept_performance: true,
    accept_other: false
  }
})

unsubscribe Event

Triggered when a user unsubscribes from a list or service.

Parameter	Required?	Format	Description
name	Required	String	Event name 'unsubscribe'
data.id	Optional	String or Number	Subscription or list ID
data.reason	Optional	String or Number	Unsubscribe reason

_almeta.t('event', {
  name: 'unsubscribe',
  data: {
    id: 'LIST-12345',
    reason: 'no-longer-interested'
  }
})

video_position Event

Triggered when a video reaches a specific position or time.

Parameter	Required?	Format	Description
name	Required	String	Event name 'video_position'
data.id	Required	String or Number	Video ID (could be a URL)
data.name	Optional	String	Video name
data.seek_position	Required	Number	Current video seek position in seconds

_almeta.t('event', {
  name: 'video_position',
  data: {
    id: 'VIDEO-12345',
    name: 'Product Demo',
    seek_position: 30
  }
})

view_ad_content Event

Triggered when a user views a specific section or content within an advertisement.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_ad_content'
data.id	Required	String or Number	Advertisement ID (could be a URL)
data.name	Optional	String	Advertisement name
data.content	Required	String or Number	Advertisement video section or content ID
data.seek_position	Optional	Number	Current video seek position in seconds

_almeta.t('event', {
  name: 'view_ad_content',
  data: {
    id: 'AD-12345',
    name: 'Summer Sale',
    content: 'CONTENT-98765',
    seek_position: 15
  }
})

view_ad Event

Triggered when a user views an advertisement.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_ad'
data.id	Required	String or Number	Advertisement ID (could be a URL)
data.name	Optional	String	Advertisement name
data.seek_position	Optional	Number	Current video seek position in seconds

_almeta.t('event', {
  name: 'view_ad',
  data: {
    id: 'AD-12345',
    name: 'Summer Sale',
    seek_position: 5
  }
})

view_cart Event

Triggered when a user views their shopping cart.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_cart'
data.currency	Optional	String	Transaction currency in 3-letter ISO 4217 format
data.value	Optional	Number	Total monetary value (no shipping, no tax, after all discounts)
data.items	Optional	Array of Objects	Array of transaction items. Each object in the array should have the following properties:
		id (Required, String or Number)	Item ID
		brand (Optional, String)	Item brand
		name (Optional, String)	Item name
		variant (Optional, String or Number)	Item variant
		price (Optional, Number)	Item price
		quantity (Optional, Number)	Item quantity
		collections (Optional, Array of Strings)	Array of item collections or categories
		promotions (Optional, Array of Objects)	Array of promotions applied to the item. Each promotion object should have the following properties:
			id (Optional, String)
			name (Optional, String)
			type (Optional, String)
			coupon (Optional, String)
			discount (Optional, Number)
		location_id (Optional, String or Number)	Item location ID (e.g., store location, supplier name)
data.promotions	Optional	Array of Objects	Array of promotions applied to the transaction. Each promotion object should have the same properties as the promotions property within the items array.

_almeta.t('event', {
  name: 'view_cart',
  data: {
    currency: 'USD',
    value: 99.99,
    items: [
      {
        id: 'SKU-12345',
        name: 'Product Name',
        brand: 'Brand Name',
        variant: 'Variant Details',
        price: 49.99,
        quantity: 1,
        collections: ['category-a', 'category-b'],
        promotions: [
          {
            id: 'PROMO-ABC',
            name: 'Spring Sale',
            type: 'discount_code',
            coupon: 'SPRING2023',
            discount: 5.0
          }
        ],
        location_id: 'store-123'
      }
    ],
    promotions: [
      {
        id: 'PROMO-DEF',
        name: 'Free Shipping',
        type: 'free_shipping'
      }
    ]
  }
})

view_collection Event

Triggered when a user views a collection or product list.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_collection'
data.id	Required	String or Number	Collection ID (could be a URL)
data.name	Optional	String	Collection name
data.items_count	Optional	Number	Number of items in the collection

_almeta.t('event', {
  name: 'view_collection',
  data: {
    id: 'COLLECTION-12345',
    name: 'Summer Collection',
    items_count: 25
  }
})

view_content Event

Triggered when a user views a specific piece of content.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_content'
data.id	Required	String or Number	Content ID (could be a URL)
data.type	Optional	String	Content type (e.g., article, specification)
data.name	Optional	String	Content name

_almeta.t('event', {
  name: 'view_content',
  data: {
    id: 'CONTENT-12345',
    type: 'article',
    name: 'How to Choose the Right Product'
  }
})

view_product Event

Triggered when a user views a product.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_product'
data.id	Required	String or Number	Product ID
data.brand	Optional	String	Product brand
data.name	Optional	String	Product name
data.variant	Optional	String or Number	Product variant
data.price	Optional	Number	Product price when viewed
data.original_price	Optional	Number	Original product price when viewed
data.currency	Optional	String	Price currency in 3-letter ISO 4217 format
data.available	Optional	Boolean	Is the product available for purchase
data.rating	Optional	Number	Product rating when viewed (0 if none, 1-5 if available)

_almeta.t('event', {
  name: 'view_product',
  data: {
    id: 'SKU-12345',
    brand: 'Brand Name',
    name: 'Product Name',
    variant: 'Red',
    price: 49.99,
    original_price: 59.99,
    currency: 'USD',
    available: true,
    rating: 4.5
  }
})

view_product_media Event

Triggered when a user views a media item associated with a product.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_product_media'
data.product_id	Required	String or Number	Product ID
data.product_brand	Optional	String	Product brand
data.product_name	Optional	String	Product name
data.product_variant	Optional	String or Number	Product variant
data.type	Optional	String	Media type (e.g., image, video)
data.id	Required	String or Number	Media content ID

_almeta.t('event', {
  name: 'view_product_media',
  data: {
    product_id: 'SKU-12345',
    product_brand: 'Brand Name',
    product_name: 'Product Name',
    product_variant: 'Red',
    type: 'video',
    id: 'MEDIA-98765'
  }
})

view_promotion Event

Triggered when a user views a promotion.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_promotion'
data.promotion	Optional	Array of Objects	Array of promotion details. Each object in the array should have the following properties:
		id (Optional, String)	Promotion ID
		name (Optional, String)	Promotion name
		type (Optional, String)	Promotion type (e.g., discount_code, buy_one_get_one, etc.)
		coupon (Optional, String)	Coupon code associated with the promotion
		discount (Optional, Number)	Discount value

_almeta.t('event', {
  name: 'view_promotion',
  data: {
    promotion: [
      {
        id: 'PROMO-ABC',
        name: 'Spring Sale',
        type: 'discount_code',
        coupon: 'SPRING2023',
        discount: 10.0
      }
    ]
  }
})

view_video_content Event

Triggered when a user views a specific section or content within a video.

Parameter	Required?	Format	Description
name	Required	String	Event name 'view_video_content'
data.id	Required	String or Number	Video ID (could be a URL)
data.name	Optional	String	Video name
data.content	Required	String or Number	Video section or content ID
data.seek_position	Optional	Number	Current seek position in seconds

_almeta.t('event', {
  name: 'view_video_content',
  data: {
    id: 'VIDEO-12345',
    name: 'Product Demo',
    content: 'CONTENT-98765',
    seek_position: 30
  }
})