Data integration

With Oktium data collection is easy. The collected data syncs directly to your own CMS system or any other analytics tool.
Every bit of data you receive reflects the events that took place in every Oktium call between your customers and your staff.

What kind of data you can collect?

• Customer information
• Call logs
• Orders list and their details
• Appointment list and their details

Customer model

All Customer model data depends on customer approval what he is willing to share with your business.

• Oktium customer Id
• First name: type: String
• Last name: type: String (require approval)
• Email: type: String (require approval)
• Phone number: type: String (require approval)
• Address (require approval)

Street

City

ZIP

State

Call model

• incoming Date: type: Date
• accepted Date: type: Date
• ending Date: type: Date
• shop Name: type: String
• branch Id
• customer Id
• seller Id
• finished By

Order model

• order No.: type: String
• branch Id
• customer Id
• seller Id
• call Id
• products:

product Id

name: type: String

price: type: Number

• total Price: type: Number
• currency
• vat Rate: type: Number
• shipping: type: Number
• first Name: type: String
• last Name: type: String
• email: type: String
• confirmed At: type: Date
• paid At: type: Date
• ready At: type: Date
• shipped At: type: Date
• address: type: Address
• charge Response
• refund Response
• branchName: type: String
• status: type: String
• tax Free: type: Boolean
• branchImage URL: type: String
• customer Id

Appointment model

• Seller Id
• Branch Id
• Customer Id
• Start Date: type: Date
• End Date: type: Date
• Address: Address
• Customer Phone: type: String
• Seller Phone: type: String

Webhooks

Oktium’s webhook system allows you to receive, install and funnel-down event data from us as it occurs for install attribution or conversion funnels in your own database. You simply need to specify a URL to which we should send all this data. After that you will receive every event related to your business at your address as POST method in JSON format.

HTTP headers

All event payload requests have the following HTTP headers:

List of supported webhook events and topics

You can retrieve data in JSON format. Webhooks are available for the following events:

Calls:

{
"_id": "590ee2f7195e9c5ad3d564da",
"branchId": "586a307b9bd39307360d938d",
"customerId": "5853bf13364ab36fca5333cf",
"incoming": "2017-05-07T09:03:51.697Z",
"ending": "2018-07-28T11:54:36.537Z",
"accepted": "2017-10-06T09:02:16.619Z",
"sellerId": "598197a48d40c8000fa907bd",
"ending": "2017-10-06T09:02:46.655Z",
"finishedBy": "59ce206a597241000f683c12",
"shopName": "Mark Borghi Fine Art",
"totalSpending": 0,
"customer": {
"_id": "5853bf13364ab36fca5333cf",
"email": "customer@email.com",
"lastName": "John",
"phone": {
"domesticNumber": "8009991111",
"_id": "587f5887e674667d498328a5"
},
"firstName": "Doe",
"lastLogin": "2017-01-12T19:05:01.301Z",
"languages":
"en"
,
"addresses":
{
"country": "US",
"state": "NY",
"_id": "5853bf13364ab36fca5333d1",
"postCode": "10001",
"city": "New York",
"street": "11 Strom st"
}

}
}

Order:

{
"_id": "59b665ed801997000f51be1b",
"totalPrice": 55,
"callId": "59b665a5ab57b3001cd6acee",
"branchId": "598197a58d40c8000fa907c2",
"taxFree": false,
"address": {
"state": "NY",
"city": "New York",
"location":
-73.9964609,
40.72951339999999
,
"street": "35 5th Ave",
"postCode": "10003",
"country": "US",
"_id": "59aeb447aec29a001498e4dc"
},
"customerId": "59a6761d2a2b21000fb1f396",
"status": "confirmed",
"shipping": 5,
"vatRate": 9,
"sellerId": "59b66598801997000f51bd73",
"createdAt": "2017-09-11T10:31:09.766Z",
"currency": "USD",
"products":
{
"name": "SuperStuff",
"price": 55,
"_id": "59b665ed801997000f51be1c"
}
,
"orderNo": "CX-00000160",
"customer": {
"_id": "59a6761d2a2b21000fb1f396",
"email": "customer@email.com",
"lastName": "Awesome",
"phone": {
"dialCode": {
"domesticNumber": "8009991111",
"_id": "59afaa9d00ae9a0014fa3ade",
"dialCode": {
"name": "United States",
"_id": "5756fd96a79a274a3559c49f",
"code": "US",
"dial_code": "+1"
}
},
"_id": "59a6a6342a2b21000fb1fbdd",
"domesticNumber": "25825825866"
},
"firstName": "Terez",
"languages":
"en"
,
"address":
{
"state": "NY",
"city": "New York",
"location":
-73.9964609,
40.72951339999999
,
"street": "35 5th Ave",
"postCode": "10003",
"country": "US",
"_id": "59aeb447aec29a001498e4dc"
}

},
"businessId": "598197a58d40c8000fa907c0"
}

Appointment:

{
"_id": "59afaa9d00ae9a0014fa3adc",
"sellerPhone": {
"domesticNumber": "8009991111",
"_id": "59afaa9d00ae9a0014fa3ade",
"dialCode": {
"name": "United States",
"_id": "5756fd96a79a274a3559c49f",
"code": "US",
"dial_code": "+1"
}
},
"businessLink": "http://business.face2.io/new-york-university",
"branchId": "59aeb447aec29a001498e4da",
"startDate": "2017-09-06T08:58:17.662Z",
"endDate": "2017-09-06T09:58:17.662Z",
"address": {
"state": "NY",
"city": "New York",
"location":
-73.9964609,
40.72951339999999
,
"street": "35 5th Ave",
"postCode": "10003",
"country": "US",
"_id": "59aeb447aec29a001498e4dc"
},
"sellerId": "59aeb446aec29a001498e4d3",
"customerId": "59a6761d2a2b21000fb1f396"
}