Skip to main content
WEBHOOK
customer.created
{
  "data": {
    "id": "cus_GqfKXLmg61LURZhB",
    "object": "customer",
    "environment": "sandbox",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phoneNumber": "254712345678",
    "description": "VIP customer with recurring payments",
    "countryCode": "KE",
    "isActive": true,
    "isVerified": true,
    "lastActiveAt": "2024-12-19T16:45:00.000Z",
    "firstTransactionAt": "2024-12-15T09:15:00.000Z",
    "preferredPaymentMethod": "m-pesa",
    "source": "api",
    "metadata": {
      "user_preference": "dark_mode",
      "last_login": 1640995200,
      "is_premium": true,
      "account_balance": 1250.75,
      "notifications_enabled": false
    },
    "createdAt": "2024-12-10T08:30:00.000Z",
    "updatedAt": "2024-12-19T14:22:00.000Z"
  },
  "timestamp": "2021-01-01T00:00:00Z",
  "type": "customer.created",
  "object": "event"
}

Authorizations

​
Authorization
string
header
required

The API key to use for authentication

Body

application/json

Customer Schema

Webhook payload for customer.created events

​
data
object
required
​
timestamp
string
required

ISO 8601 timestamp when the event occurred

Example:

"2021-01-01T00:00:00Z"

​
type
string
default:customer.created

Event type for customer.created

Example:

"customer.created"

​
object
string
default:event

Object type, always "event"

Example:

"event"

Response

200

Webhook received successfully