> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mailerpath.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Event Payload Examples

> Copy-ready payload patterns for common business scenarios.

Use these as starter payloads and adjust identifiers, timestamps, and metadata for your product.

## Base Shape

### Recommended payload

```json theme={null}
{
  "email": "buyer@example.com",
  "type": "purchase",
  "source": "api",
  "action": "renewed",
  "feature": "billing",
  "plan": "pro",
  "amount": 49.9,
  "idempotency_key": "purchase-buyer-example-com-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "email": "buyer@example.com",
  "type": "purchase"
}
```

## 1) Signup

### Recommended payload

```json theme={null}
{
  "email": "newuser@example.com",
  "type": "signup",
  "source": "organic",
  "idempotency_key": "signup-newuser-example-com-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "email": "newuser@example.com",
  "type": "signup"
}
```

## 2) Purchase Success

### Recommended payload

```json theme={null}
{
  "email": "buyer@example.com",
  "type": "purchase",
  "status": "success",
  "plan": "pro",
  "amount": 49.9,
  "upgrade": false,
  "idempotency_key": "purchase-buyer-example-com-20260622-1"
}
```

### Minimum payload

```json theme={null}
{
  "email": "buyer@example.com",
  "type": "purchase",
  "status": "success"
}
```

## 3) Trial Started

### Recommended payload

```json theme={null}
{
  "email": "trialuser@example.com",
  "type": "purchase",
  "status": "trial_started",
  "plan": "trial",
  "idempotency_key": "trial-trialuser-example-com-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "email": "trialuser@example.com",
  "type": "purchase",
  "status": "trial_started"
}
```

## 4) Core Activity (Login)

### Recommended payload

```json theme={null}
{
  "uid": "usr_00123",
  "type": "core_activity",
  "action": "login",
  "source": "web_app",
  "idempotency_key": "login-usr-00123-20260622t110001z"
}
```

### Minimum payload

```json theme={null}
{
  "uid": "usr_00123",
  "type": "core_activity",
  "action": "login"
}
```

## 5) Feature Exploration

### Recommended payload

```json theme={null}
{
  "uid": "usr_00123",
  "type": "feature_used",
  "action": "explored",
  "feature": "automation_builder",
  "source": "dashboard",
  "idempotency_key": "feature-explored-usr-00123-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "uid": "usr_00123",
  "type": "feature_used",
  "action": "explored"
}
```

## 6) Support Escalation Pattern

### Recommended payload

```json theme={null}
{
  "email": "help@example.com",
  "type": "support_ticket",
  "action": "multiple_tickets",
  "source": "support_system",
  "idempotency_key": "support-multiple-help-example-com-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "email": "help@example.com",
  "type": "support_ticket",
  "action": "multiple_tickets"
}
```

## 7) Cart Abandoned

### Recommended payload

```json theme={null}
{
  "email": "shopper@example.com",
  "type": "cart",
  "status": "abandoned",
  "action": "abandoned",
  "amount": 129.0,
  "idempotency_key": "cart-abandoned-shopper-example-com-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "email": "shopper@example.com",
  "type": "cart",
  "status": "abandoned"
}
```

## 8) Re-Engagement Return

### Recommended payload

```json theme={null}
{
  "email": "returning@example.com",
  "type": "re_engagement",
  "action": "returned",
  "status": "success",
  "idempotency_key": "reengaged-returning-example-com-20260622"
}
```

### Minimum payload

```json theme={null}
{
  "email": "returning@example.com",
  "type": "re_engagement",
  "action": "returned"
}
```

## Bulk Submission Example

### Recommended payload

```json theme={null}
{
  "events": [
    {
      "email": "newuser@example.com",
      "type": "signup",
      "source": "organic",
      "idempotency_key": "signup-newuser-example-com-20260622"
    },
    {
      "email": "buyer@example.com",
      "type": "purchase",
      "status": "success",
      "plan": "pro",
      "amount": 49.9,
      "idempotency_key": "purchase-buyer-example-com-20260622-1"
    }
  ]
}
```

### Minimum payload

```json theme={null}
{
  "events": [
    {
      "email": "newuser@example.com",
      "type": "signup"
    },
    {
      "email": "buyer@example.com",
      "type": "purchase"
    }
  ]
}
```

## Invalid Example And Fix

Invalid (missing email and uid):

```json theme={null}
{
  "type": "signup"
}
```

Fixed:

```json theme={null}
{
  "email": "fixed@example.com",
  "type": "signup",
  "idempotency_key": "signup-fixed-example-com-20260622"
}
```

## Example Quality Checklist

* include deterministic idempotency\_key values
* use canonical event type names
* include source for easier diagnostics
* include ts when importing historical events
* keep metadata compact and meaningful