User Register

This documentation outlines the User Register webhook's purpose, triggers, payload structure, and benefits.

Overview

The User Register webhook is triggered when a new user successfully registers on your platform. This webhook allows you to track and respond to user registration events in real time, enabling you to automate processes such as sending welcome emails, assigning customer segments, or triggering onboarding workflows.

Triggers

• Register: This webhook is triggered whenever a new user registers on your platform.

Payload Format

When the Register event is triggered, a POST request is sent to your configured endpoint. The payload includes essential details about the shop and the newly registered customer.

Payload Parameters:

• event: "Register" — Identifies the event type as related to user registration.

• shop: Contains details about the shop where the user registered:

  • id: The unique ID of the shop.

  • name: The name of the shop.

  • title: The title or brand of the shop.

  • domain: The shop's domain or URL.

• customer: Contains details about the customer who registered, including:

  • The customer object, which includes information such as the customer’s ID, name, email, and any other associated data. This can also be null if no customer data is available.

Sample Payload

{
  "event": "Register",
  "shop": {
    "id": 1,
    "name": "pajuhaan",
    "title": "Rocketiox",
    "domain": "http://localhost:9000/@pajuhaan"
  },
  "customer": {
    "id": 74,
    "name": "John Doe",
    "email": "user*****@mail.com",
    "phone": "*****603"
  }
}

Benefits

• Real-time user tracking: Immediately know when new users register on your platform.

• Automate user onboarding: Trigger automated actions like sending a welcome email, assigning loyalty programs, or adding the user to specific customer segments.

• Comprehensive data: The payload provides critical details about the shop and the newly registered user, allowing seamless integration with your CRM or marketing tools.