Subscriber Events

Lumail automatically tracks various subscriber events to help you understand subscriber behavior and engagement. These events appear in the subscriber timeline and can be used for segmentation and automation triggers.

Most events are created automatically by the system as subscribers interact with your emails or undergo status changes. However, some events like payments and refunds need to be manually tracked through the Events API.

Revenue Events (Manual Tracking Required)

These events need to be manually tracked via the Events API. See Revenue Tracking for implementation guide.

SUBSCRIBER_PAYMENT

Records when a subscriber makes a payment or purchase.

Required Data Fields:

• amount: number - The payment amount
• product: string - Name of the product or service purchased

SUBSCRIBER_REFUND

Records when a subscriber receives a refund.

Required Data Fields:

• amount: number - The refund amount
• product: string - Name of the product or service refunded

Email Engagement Events (Automatic)

These events are tracked automatically by Lumail:

EMAIL_SENT

Recorded when an email is sent to a subscriber.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string - ID of the associated campaign
• subject: string - Subject line of the email
• workflow: object (optional) - Contains workflow ID and name if sent via automation

EMAIL_RECEIVED

Recorded when an email is successfully delivered to a subscriber's inbox.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string - ID of the associated campaign
• subject: string - Subject line of the email
• receivedAt: string - Timestamp when the email was delivered

EMAIL_OPENED

Recorded when a subscriber opens an email.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string - ID of the associated campaign
• subject: string - Subject line of the email

EMAIL_CLICKED

Recorded when a subscriber clicks a link in an email.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string - ID of the associated campaign
• subject: string - Subject line of the email
• link: string - The URL that was clicked
• userAgent: string (optional) - Browser and device information

EMAIL_DELIVERY_DELAYED

Recorded when email delivery is temporarily delayed.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string (optional) - ID of the associated campaign
• subject: string - Subject line of the email
• workflow: object (optional) - Contains workflow ID and name if sent via automation

EMAIL_BOUNCED

Recorded when an email cannot be delivered to a subscriber.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string - ID of the associated campaign
• subject: string - Subject line of the email
• reason: string - Reason for the bounce
• bounceType: string - Type of bounce (hard or soft)
• userEmail: string (optional) - Email address that bounced

EMAIL_COMPLAINED

Recorded when a subscriber marks an email as spam.

Tracked Data:

• emailId: string - Unique identifier for the email
• campaignId: string - ID of the associated campaign
• subject: string - Subject line of the email

Subscription Events (Automatic)

These events are related to subscriber status changes:

SUBSCRIBED

Recorded when a new subscriber joins your list.

Tracked Data:

• tags: array (optional) - Initial tags applied to the subscriber

UNSUBSCRIBED

Recorded when a subscriber opts out of your list.

Tracked Data:

• reason: string (optional) - Reason provided for unsubscribing
• campaignId: string (optional) - ID of the campaign that triggered the unsubscribe
• campaignName: string (optional) - Name of the campaign that triggered the unsubscribe
• status: string (optional) - Updated subscriber status

Tag Events (Automatic)

These events track changes to subscriber tags. Manage tags programmatically with the Tags API and Add Tags API.

TAG_ADDED

Recorded when a tag is applied to a subscriber.

Tracked Data:

• tagId: string - Unique identifier for the tag
• tagName: string - Name of the tag
• reason: string (optional) - Reason the tag was added

TAG_REMOVED

Recorded when a tag is removed from a subscriber.

Tracked Data:

• tagId: string - Unique identifier for the tag
• tagName: string - Name of the tag
• reason: string (optional) - Reason the tag was removed

Workflow Events (Automatic)

These events track subscriber journey through automated workflows. Learn more about Workflows.

WORKFLOW_STARTED

Recorded when a subscriber enters an automation workflow.

Tracked Data:

• workflowId: string - Unique identifier for the workflow
• workflowName: string - Name of the workflow

WORKFLOW_COMPLETED

Recorded when a subscriber completes all steps in a workflow.

Tracked Data:

• workflowId: string - Unique identifier for the workflow
• workflowName: string - Name of the workflow

WORKFLOW_CANCELED

Recorded when a subscriber is removed from a workflow before completion.

Tracked Data:

• workflowId: string - Unique identifier for the workflow
• workflowName: string - Name of the workflow
• reason: string (optional) - Reason for cancellation

WEBHOOK_EXECUTED

Recorded when a webhook step within a workflow is triggered for a subscriber.

Tracked Data:

• workflowId: string - Unique identifier for the workflow
• workflowName: string - Name of the workflow
• stepId: string - ID of the specific workflow step
• webhookUrl: string - The URL that was called
• status: number - HTTP status code returned
• success: boolean - Whether the webhook was successfully executed
• errorMessage: string (optional) - Error message if the webhook failed

Other Events (Automatic)

FIELD_UPDATED

Recorded when a custom field value is updated for a subscriber.

Tracked Data:

• fieldId: string - Unique identifier for the field
• fieldName: string - Name of the field
• oldValue: string (optional) - Previous value of the field
• newValue: string - New value of the field

Using Events in Lumail

Subscriber events have several useful applications:

1. Subscriber Timeline - View a chronological history of all subscriber interactions
2. Segmentation - Create targeted segments based on subscriber behavior
3. Automation Triggers - Start workflows when specific events occur
4. Analytics - Measure engagement and conversion rates
5. Revenue Tracking - Track purchase behavior and calculate subscriber lifetime value

For more information on how to manually track events, see the Events API documentation.

To retrieve a subscriber's event history programmatically, see the Get Subscriber Events API.