---
title: User Events
description: Documentation for user-related webhook events
sidebar:
  label: User Events
---

This section covers all webhook events related to users, including user creation, updates, email verification, and deletions.

## Event Types

The following user-related events are available:

- `user.create` - Triggered when a new user is created
- `user.update` - Triggered when a user's information is modified
- `user.verify_email_success` - Triggered when a user verifies their email
- `user.deleted` - Triggered when a user is deleted

## User Created/Updated/Verified Event

The `user.create`, `user.update`, and `user.verify_email_success` events share the same payload structure.

### Event Structure

```json
{
  "event_type": "user.create", // or user.update, user.verify_email_success
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "status": "active",
    "market": "US",
    "store_group": "main-store",
    "language": "en",
    "additions": {
      "newsletter_subscription": "true",
      "account_type": "personal"
    },
    "email_verified": true,
    "phone_number": "+1234567890",
    "communication_preferences": {
      "email_marketing": true,
      "sms_marketing": false,
      "push_notifications": true
    },
    "address": {
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US",
      "is_default": true
    }
  }
}
```

### Field Descriptions

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Unique identifier for the user |
| `email` | string | User's email address |
| `first_name` | string | User's first name |
| `last_name` | string | User's last name |
| `status` | string | The user's status. Can be `active`, `inactive`, or `pending`. |
| `market` | string | User's primary market |
| `store_group` | string | Associated store group |
| `language` | string | Preferred language code |
| `additions` | object | Additional custom user attributes |
| `email_verified` | boolean | Whether email is verified |
| `phone_number` | string | User's phone number |
| `communication_preferences` | object | Marketing and communication preferences |
| `address` | object | Default shipping/billing address |

## User Deleted Event

The `user.deleted` event is triggered when a user is removed from the system.

### Event Structure

```json
{
  "event_type": "user.deleted",
  "payload": {
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "status": "inactive",
      "market": "US",
      "store_group": "main-store",
      "language": "en",
      "additions": {},
      "email_verified": true,
      "phone_number": "+1234567890",
      "communication_preferences": {},
      "address": {}
    },
    "soft_delete": true
  }
}
```

### Field Descriptions

| Field | Type | Description |
|-------|------|-------------|
| `user` | object | Complete user object being deleted |
| `soft_delete` | boolean | Whether this is a soft delete (recoverable) |