User Leave

This documentation covers the User Leave webhook's functionality, trigger, and payload structure.

Overview

The User Leave webhook is triggered when a user leaves or unsubscribes from your shop. This webhook is useful for tracking user churn and automating processes like sending retention emails or gathering feedback on why users left.

Triggers

• Leave: This webhook is triggered whenever a user leaves or unsubscribes from your platform.

Payload Format

When the Leave event is triggered, a POST request is sent to your configured endpoint. The payload provides relevant information about the shop and the customer who left.

Payload Parameters:

• event: "Leave" — Identifies the event type as related to a user leaving.

• shop: Contains details about the shop from which the user has left:

  • 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 left the shop. This can include:

  • The customer object with information such as their ID, name, email, and other attributes, or it can be null if no specific customer data is available.

Sample Payload

{
  "event": "Leave",
  "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

• Track user churn: Immediately know when users leave your platform and respond appropriately.

• Retention efforts: Trigger automated processes to send follow-up emails, request feedback, or offer special promotions to retain users.

• Detailed data: Get essential information about the customer who has left, allowing for personalized follow-up actions.