1. Giới thiệu
AntCRM Data platform cho phép người sử dụng xuất dữ liệu từ AntCRM Data Platform ra những hệ thống bên ngoài để phục vụ các công việc trên hệ thống đó 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ừ AntCRM 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 AntCRM Webhook URL
Để xuất dữ liệu từ hệ thống AntCRM Data Platform ra bên ngoài, người dùng cần phải được 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ừ AntCRM 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 Chỉ có tài khoản admin hoặc owner mới có quyền cấu hình URL. Các bước thực hiện cụ thể như bên dưới:
Bước 1: Vào phần Thiết lập → chọn Thiết lập khác → 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 đến ra ngoài
Bước 4: Cấu hình điều kiện để AntCRM 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 AntCRM Webhook để tìm hiểu chi tiết các sự kiện mà AntCRM Data Platform cung cấp.
Sau khi thêm mới Webhook URL, giao diện AntCRM Data Platform sẽ hiển thị như sau
2.2. Sự kiện của AntCRM Webhook
Các sự kiện AntCRM 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 AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Cập nhật | Khi contact được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Thêm ghi chú hoặc comment | Khi contact được thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Task | Tạo mới | Khi nhiệm vụ được tạo mới AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Cập nhật | Khi nhiệm vụ được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Thêm ghi chú | Khi nhiệm vụ được thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Chỉ định (Assign) | Khi nhiệm vụ được Assign AntCRM 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 AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Cập nhật | Khi Ticket được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Thêm ghi chú | Khi Ticket được thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Chỉ định (Assign) | Khi Ticket được Assign AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Giao dịch (Deal) | Tạo mới | Khi Giao dịch được tạo mới AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Cập nhật | Khi Giao dịch được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình |
Thêm ghi chú | Khi Giao dịch được thêm ghi chú AntCRM 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 AntCRM Data platform
Field Name | Kiểu | Mô tả |
eventCode | string | Xem bảng EventCode |
createdBy | Object | avatar: "/static/avatars/57f2399cd7351a3e75f8aa1a1477998580867" email:"tran.le@htklabs.com" firstname:"Tran" id:"57f2399cd7351a3e75f8aa1a" lastname:"Le"
|
contact | Object | {lastname:"" name:"huyen@grandpasgarđến.org"}
Chú ý: Contact danh cho các event của contact và có liên quan đến contact
|
ticket | Object | {TicketId:434 assignedTo:"584a439acdff33ff1756b4df" createdBy:"584a439acdff33ff1756b4df" followers:[] group:"584a4142cdff33ff1756b4d3" id:"59b290f6820385fd1e26c3e5" title:"Cai dat pfsense cho van phong moi"}
Chú ý: - Ticket dành cho các event liên quan đến ticket - assignTo sẽ được populate để lấy thông tin người / group được assigned |
task | Object | {"taskId":3704, "assignTo":"5923f118cacbe6ed63bb7bbe", "createdBy":"57fb8157fa0e60a8625145a8", "completedBy":"5923f118cacbe6ed63bb7bbe", "Permit":{"status":1,"users":[]}, "Id":"59ae89d521f7cfa03f02f8eb" }
Chú ý: - Ticket dành cho các event liên quan đến task - assignTo sẽ được populate để lấy thông tin người / group được assigned |
content | string | Chuỗi sẽ hiển thị. Ví dụ:
|
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 |
CONTACT_CHANGE_STAGE | Cập nhật stage cho contact |
TICKET_CHANGE | Cập nhật ticket |
TICKET_CREATE | Tạo ticket |
TASK_CREATE | Tạo task |
TASK_CHANGE | Cập nhật task |
DEAL_CREATE | Tạo deal |
DEAL_CHANGE | Cập nhật deal |
NOTE_CREATE | Tao note |