Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.enad.io/llms.txt

Use this file to discover all available pages before exploring further.

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

{
  "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

FieldTypeDescription
idstringUnique identifier for the user
emailstringUser’s email address
first_namestringUser’s first name
last_namestringUser’s last name
statusstringThe user’s status. Can be active, inactive, or pending.
marketstringUser’s primary market
store_groupstringAssociated store group
languagestringPreferred language code
additionsobjectAdditional custom user attributes
email_verifiedbooleanWhether email is verified
phone_numberstringUser’s phone number
communication_preferencesobjectMarketing and communication preferences
addressobjectDefault shipping/billing address

User Deleted Event

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

Event Structure

{
  "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

FieldTypeDescription
userobjectComplete user object being deleted
soft_deletebooleanWhether this is a soft delete (recoverable)