User
v1
Description
Get notified on creation, updation, or deletion of registered users of your sales channel.
Supported Type
- Create
- Update
- Delete
Payload
Create
{
"meta": {
"job_type": "users",
"action": "upsert",
"trace": [
"deadlock.043dbfb0-09aa-11ee-afa1-21e8b63e081b"
],
"event": {
"name": "user",
"type": "create",
"version": "1"
},
"service": {
"name": "deadlock"
},
"company_id": 1,
"trace_id": ["deadlock.043dbfb0-09aa-11ee-afa1-21e8b63e081b"],
"created_timestamp": 1686649727621,
"application_id": ["000000000000000000000001"],
"extension_id": []
},
"payload": [
{
"user": {
"debug": {
"source": "deadlock",
"platform": "000000000000000000000001"
},
"gender": "male",
"accountType": "user",
"active": true,
"archive": false,
"status": "activated",
"profilePicUrl": "/addsale/misc/default-assets/original/default-user-profile.png",
"hasOldPasswordHash": false,
"_id": "6487fc9f66a6031a8b68f523",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "8285462419",
"countryCode": 91,
"country_code": 91
}
],
"applicationId": "000000000000000000000001",
"firstName": "Salman",
"lastName": "Saudagar",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "salmansaudagar@gofynd.com"
}
],
"username": "salmansaudagar_gofynd_com_31354_000000000000000000000001",
"userId": "6487fc9f66a6031a8b68f523",
"createdAt": "2023-06-13T05:20:31.356Z",
"updatedAt": "2023-06-13T05:20:31.356Z",
"__v": 0,
"id": "6487fc9f66a6031a8b68f523",
"account_type": "user",
"profile_pic_url": "/addsale/misc/default-assets/original/default-user-profile.png",
"has_old_password_hash": false,
"phone_numbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "8285462419",
"countryCode": 91,
"country_code": 91
}
],
"application_id": "000000000000000000000001",
"first_name": "Salman",
"last_name": "Saudagar",
"user_id": "6487fc9f66a6031a8b68f523",
"created_at": "2023-06-13T05:20:31.356Z",
"updated_at": "2023-06-13T05:20:31.356Z",
"is_created": true
},
"socialAccounts": []
}
],
"user_id": "6487fc9f66a6031a8b68f523"
}
Update
{
"meta": {
"job_type": "users",
"action": "upsert",
"trace": [
"deadlock.043dbfb0-09aa-11ee-afa1-21e8b63e081b"
],
"event": {
"name": "user",
"type": "update",
"version": "1"
},
"service": {
"name": "deadlock"
},
"company_id": 1,
"trace_id": ["deadlock.043dbfb0-09aa-11ee-afa1-21e8b63e081b"],
"created_timestamp": 1686649727621,
"application_id": ["000000000000000000000001"],
"extension_id": []
},
"payload": [
{
"user": {
"debug": {
"source": "deadlock",
"platform": "000000000000000000000001"
},
"gender": "male",
"accountType": "user",
"active": true,
"archive": false,
"status": "activated",
"profilePicUrl": "/addsale/misc/default-assets/original/default-user-profile.png",
"hasOldPasswordHash": false,
"_id": "6487fc9f66a6031a8b68f523",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "8285462419",
"countryCode": 91,
"country_code": 91
}
],
"applicationId": "000000000000000000000001",
"firstName": "Salman",
"lastName": "Saudagar",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "salmansaudagar@gofynd.com"
}
],
"username": "salmansaudagar_gofynd_com_31354_000000000000000000000001",
"userId": "6487fc9f66a6031a8b68f523",
"createdAt": "2023-06-13T05:20:31.356Z",
"updatedAt": "2023-06-13T05:20:31.356Z",
"__v": 0,
"id": "6487fc9f66a6031a8b68f523",
"account_type": "user",
"profile_pic_url": "/addsale/misc/default-assets/original/default-user-profile.png",
"has_old_password_hash": false,
"phone_numbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "8285462419",
"countryCode": 91,
"country_code": 91
}
],
"application_id": "000000000000000000000001",
"first_name": "Salman",
"last_name": "Saudagar",
"user_id": "6487fc9f66a6031a8b68f523",
"created_at": "2023-06-13T05:20:31.356Z",
"updated_at": "2023-06-13T05:20:31.356Z",
"is_created": true
},
"socialAccounts": []
}
],
"user_id": "6487fc9f66a6031a8b68f523"
}
Delete
{
"meta": {
"job_type": "users",
"action": "delete",
"trace": [
"deadlock.043dbfb0-09aa-11ee-afa1-21e8b63e081b"
],
"event": {
"name": "user",
"type": "delete",
"version": "1"
},
"service": {
"name": "deadlock"
},
"company_id": 1,
"trace_id": ["deadlock.043dbfb0-09aa-11ee-afa1-21e8b63e081b"],
"created_timestamp": 1686649727621,
"application_id": ["000000000000000000000001"],
"extension_id": []
},
"payload": [
{
"user": {
"debug": {
"source": "deadlock",
"platform": "000000000000000000000001"
},
"gender": "male",
"accountType": "user",
"active": true,
"archive": false,
"status": "activated",
"profilePicUrl": "/addsale/misc/default-assets/original/default-user-profile.png",
"hasOldPasswordHash": false,
"_id": "6487fc9f66a6031a8b68f523",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "8285462419",
"country_code": 91
}
],
"applicationId": "000000000000000000000001",
"firstName": "Salman",
"lastName": "Saudagar",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "salmansaudagar@gofynd.com"
}
],
"username": "salmansaudagar_gofynd_com_31354_000000000000000000000001",
"userId": "6487fc9f66a6031a8b68f523",
"createdAt": "2023-06-13T05:20:31.356Z",
"updatedAt": "2023-06-13T05:20:31.356Z",
"__v": 0,
"id": "6487fc9f66a6031a8b68f523",
"account_type": "user",
"profile_pic_url": "/addsale/misc/default-assets/original/default-user-profile.png",
"has_old_password_hash": false,
"phone_numbers": [
{
"active": true,
"primary": true,
"verified": true,
"phone": "8285462419",
"country_code": 91
}
],
"application_id": "000000000000000000000001",
"first_name": "Salman",
"last_name": "Saudagar",
"user_id": "6487fc9f66a6031a8b68f523",
"created_at": "2023-06-13T05:20:31.356Z",
"updated_at": "2023-06-13T05:20:31.356Z",
},
}
],
"user_id": "6487fc9f66a6031a8b68f523"
}
Object Properties
| Name | Type | Description | Required |
|---|---|---|---|
| application_id | String | Unique ID of the application | |
| active | Boolean | Shows whether user is blocked or unblocked | |
| archive | Boolean | Shows whether user is deleted or present | |
| status | Boolean | Status of the user, e.g. activated | |
| username | String | User name of the user | |
| user_id | String | User's unique ID | |
| first_name | String | First name of the user | |
| last_name | String | Last name of the user | |
| profile_pic_url | String | Link to the profile picture of the user | |
| is_created | Boolean | Shows if it is a new user or updated user | |
| phone_numbers | Array | User phone numbers' array | |
| emails | Array | User emails' array | |
| gender | String / Null | User gender | |
| meta | String / Object | Meta information for users |