Hướng dẫn xuất dữ liệu tự động từ BeeIQ Data platform

1. Giới thiệu

BeeIQ Data platform cho phép người sử dụng xuất dữ liệu từ BeeIQ Data Platform ra những hệ thống bên ngoài để theo dõi, thông báo, cập nhật dữ liệu. Tài liệu này dùng để hướng dẫn cách thực hiện xuất dữ liệu từ BeeIQ Data Platform một cách tự động.

2. Hướng dẫn cấu hình

2.1. Hướng dẫn Cấu hình BeeIQ Webhook URL

Để xuất dữ liệu từ hệ thống BeeIQ Data Platform ra bên ngoài, người dùng cần phải cài đặt Webhook URL cho tài khoản của riêng mình. URL này là đường dẫn của hệ thống mà người dùng muốn đưa dữ liệu ra ngoài từ BeeIQ Data Platform. Mỗi tài khoản người dùng có thể chèn nhiều URL cho nhiều mục đích. Để cấu hình URL này, người dùng cần đăng nhập hệ thống bằng tài khoản admin hoặc owner. Các bước thực hiện cụ thể như bên dưới:

Bước 1: Vào phần Cài đặt → chọn Other settings → chọn Webhook

Bước 2: Chọn Tab Webhook

Bước 3: Nhập URL của hệ thống mà bạn muốn xuất dữ liệu ra ngoài

Bước 4: Cấu hình điều để BeeIQ Data Platform gửi sự kiện ra ngoài → chọn Thêm Webhook

Lưu ý: Xem mục 2.2. Sự kiện của BeeIQ Webhook để tìm hiểu chi tiết các sự kiện mà BeeIQ Data Platform cung cấp.

Sau khi thêm mới Webhook URL, giao diện BeeIQ Data Platform sẽ hiển thị như sau

2.2. Sự kiện của BeeIQ Webhook

Các sự kiện BeeIQ Webhook hỗ trợ đẩy thông tin ra ngoài, được mô tả như bên dưới


Trường thông tin

Sự kiện

Mô tả

Contact

Tạo mới

Khi Contact được tạo mới, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Cập nhật

Khi Contact được cập nhật, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Task

Tạo mới

Khi Task được tạo mới, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Cập nhật

Khi Task được cập nhật, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Ticket

Tạo mới

Khi Ticket được tạo mới, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Cập nhật

Khi Ticket được cập nhật, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Giao dịch                         (Opportunity)

Tạo mới

Khi Giao dịch(Opportunity) được tạo mới, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Cập nhật

Khi Giao dịch(Opportunity) được cập nhật, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình

Ghi chú

Tạo mới

Khi Contact, Task, Ticket, Opportunity (Deal) được thêm ghi chú, BeeIQ Webhook sẽ đẩy thông tin đến Webhook URL cấu hình


2.3. Mô tả tham số

Dưới đây là bảng mô tả các tham số của BeeIQ Data platform


Trường thông tin

Kiểu

Mô tả

eventCode

string

Xem bảng EventCode

createdBy

Object

Trường thông tin người tạo

Ví dụ:

{

   "avatar": "/static/avatars/57f2399cd7351a867",

   "email":"tran.le@htklabs.com",

   "firstname":"Tran",

   "lastname":"Le",

   "id":"57f2399cd7351a3e75f8aa1a"

}


contact

Object

Trường thông tin Contact

Ví dụ:

{

   "lastname":"Thong",

   "name":"Nguyễn"

}


Chú ý: Contact dành cho các event của contact và có liên quan đến contact


ticket

Object

Trường thông tin Ticket

{

 "TicketId": 54,

 "title": "Yêu cầu liên hệ",

 "status": "Assigned",

 "id": "5ac5d2dd2712958f4c2d65fa"

}


Chú ý:

- Ticket dành cho các event liên quan đến ticket

task

Object

{

 "_id": "5b0cfaecd1413d5f335d5047",

 "taskId": 23,

 "assignTo": {

   "avatar": "",

   "email": "thong.nguyen@htklabs.com",

   "firstname": "Thong Nguyen",

   "lastname": "duc"

 }

}


Chú ý:

- Task dành cho các event liên quan đến task  

deal

Object

{

 "_id":"5b0cfa2bd1413d5f335d5045",

 "stage": {

   "name":"Contacted"

 },

 "name":"Giao dịch"

}


Chú ý:

- Deal (Opportunity) dành cho các event liên quan đến Deal (Opportunity)

eventContent

string

Nội dung chi tiết của event.

Ví dụ thay đổi trạng thái của deal (Opportunity):

{

 "oldValue": {

   "name":"Lead",

   "color":"#ff4444",

   "probability":0,

   "position":0,

   "id":"5882e9cb9bd9691616eafffd"

 },

 "newValue": {

   "name":"Contacted",

   "color":"#fabb3d",

   "probability":0,

   "position":1,

   "id":"5882e9cb9bd9691616eafffe"

 }

}

link

string

https://happy.beeiq.co/contacts/57fb8157fa0e60a8625145a8


Bảng eventCode:


Sự kiện

Mô tả

CONTACT_CREATE

Tạo Contact

CONTACT_CHANGE

Cập nhật Contact

TICKET_CREATE

Tạo Ticket

TICKET_CHANGE

Cập nhật Ticket

TASK_CREATE

Tạo Task

TASK_CHANGE

Cập nhật Task

DEAL_CREATE

Tạo Deal(Opportunity)

DEAL_CHANGE

Cập nhật Deal(Opportunity)

NOTE_CREATE

Tạo Note


Bài viết này có hữu ích không? Đánh giá: 0
Chi tiết bài viết:
Ngày đăng: 30/05/2018 5:01AM
Lần cập nhật gần đây: 30/05/2018 5:01AM (manle - man.le@htklabs.com)
Chia sẻ bài viết:   
Tác giả:manle (man.le@htklabs.com)