Customer

Below are the webhook store events paired with their respective data schema related to the Customer webhook events:

Customer Webhook Events Model

The following includes 3 customer webhook events that share the same model, which are mentioned in the event enum value under the Data Schema tab

Data Schema

Example

Customer Webhook Events Model

event

enum<string>

optional

Event Name

Allowed values:

customer.createdcustomer.updatedcustomer.login

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

created_at

string

optional

Timestamp of the created Event

data

object

optional

number

required

A unique identifier for the customer.

first_name

string

required

The customer's first name.

<= 25 characters

last_name

string

required

The customer's last name.

<= 25 characters

mobile

number

required

The customer's mobile phone number without the country code.

mobile_code

string

required

The country code for the customer's mobile phone number.

string <email>

required

The customer's email address.

urls

object (Urls)

required

A list of URLs associated with the customer, such as their website or social media profiles.

avatar

string

required

A URL to the customer's avatar image.

gender

enum<string>

required

The customer's gender.

Allowed values:

malefemale

birthday

object

required

city

string

required

The city where the customer lives.

country

string

required

The country where the customer lives.

country_code

string

required

The country code for the customer's country.

currency

string

required

The currency that the customer uses.

location

string

required

The customer's location, represented as a string.

updated_at

object (Date)

required

The date and time when the customer's information was last updated.

groups

array[integer]

required

A list of group IDs that the customer belongs to.

source

object

optional

Customer source information

Customers OTP (One-Time Password) Webhook Event Model

This event is triggered when a customer's One-Time Password has been requested.

Important Note

This webhook event will only be triggered if both the email and SMS attempts to send the OTP to the customer have failed.

Data Schema

Example

Customers OTP (One-Time Password) Webhook Event Model

event

string

optional

A label or title used to identify a specific event.

Example:

customer.otp.request

merchant

number

optional

Merchant ID who installed the application on their store. Get details on the Merchant via the ID using the endpoint here

Example:

1029864349

created_at

string

optional

The date and time when a particular event was created or initiated.

Example:

Wed Jun 30 2021 12:09:11 GMT+0300

data

object

optional

code

string

optional

OTP Code, a temporary and unique numeric or alphanumeric code generated for the purpose of verification.

Example:

5331

contact

string

optional

Option for contact method using phone number or email address .

Example:

+96652318526

Customer Webhook Events Model#

Customers OTP (One-Time Password) Webhook Event Model#

Customer Webhook Events Model

Customers OTP (One-Time Password) Webhook Event Model