Cho phép xuất dữ liệu AntCRM Data Platform (Guide to enable data export from AntCRM Data Platform)
1. Giới thiệu
(1. Introduction)
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. (AntCRM Data platform allows users to export data from AntCRM Data Platform to external systems to serve work on that system to monitor, notify and update data. This document is used to guide how to perform data export from AntCRM Data Platform automatically.)
2. Hướng dẫn cấu hình
(2. Configuration instruction)
2.1. Hướng dẫn Cấu hình AntCRM Webhook URL
(2.1. AntCRM Webhook URL configuration instruction)
Để 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: (To export data from the AntCRM Data Platform system to the outside, users need to install a Webhook URL for their own account. This URL is the path of the system which the user wants to export data from AntCRM Data Platform. Each user account can insert many URLs for many purposes. To configure this URL, users need to log in to the system with only admin or owner accounts have the right to configure URL.The specific steps are as below:)
Bước 1: Vào phần Thiết lập → chọn Thiết lập khác → chọn Webhook (Step 1: Enter Setting → choose Other setting → choose Webhook)
Bước 2: Chọn Tab Webhook (Step 2: Choose Webhook Tab)
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 (Step 3: Enter URL of the system that you want to export data)
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 (Step 4: Configure the condition to AntCRM Data Platform send the event out → choose 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. (Note: View section 2.2. The event of AntCRM Webhook to learn about the details of the events that AntCRM Data Platform provides.)
Sau khi thêm mới Webhook URL, giao diện AntCRM Data Platform sẽ hiển thị như sau (After adding new Webhook URL, AntCRM Data Platform interface will display as follow:)
2.2. Sự kiện của AntCRM Webhook (2.2. Event of 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 (AntCRM Webhook events support to push information out, described below:)
Khách hàng (Contact)
Tạo mới (Create new)
Khi Khách hàng được tạo mới AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a new contact is created, AntCRM Webhook will push information to the configured Webhook URL)
Khách hàng (Contact)
Cập nhật (Update)
Khi Khách hàng được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a contact is updated, AntCRM Webhook will push information to the configured Webhook URL)
Khách hàng (Contact)
Thêm ghi chú hoặc comment (Add note or comment)
Khi Khách hàng được thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a contact is added note, AntCRM Webhook will push information to the configured Webhook URL)
Task
(Nhiệm vụ)
Tạo mới (Create new)
Khi nhiệm vụ được tạo mới AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a new task is created, AntCRM Webhook will push information to the configured Webhook URL)
Task (Nhiệm vụ)
Cập nhật (Update)
Khi nhiệm vụ được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a task is updated, AntCRM Webhook will push information to the configured Webhook URL)
Task (Nhiệm vụ)
Thêm ghi chú (Add note)
Khi nhiệm vụ được thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a task is added note, AntCRM Webhook will push information to the configured Webhook URL)
Task (Nhiệm vụ)
Chỉ định (Assign)
Khi nhiệm vụ được Assign AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình
Ticket (Phiếu yêu cầu)
Tạo mới (Add note)
Khi Phiếu yêu cầu được tạo mới AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a task is added note, AntCRM Webhook will push information to the configured Webhook URL)
Ticket (Phiếu yêu cầu)
Cập nhật (Update)
Khi Phiếu yêu cầu được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a Ticket is updated, AntCRM Webhook will push information to the configured Webhook URL)
Ticket (Phiếu yêu cầu)
Add note (Ghi chú)
Khi phiếu yêu cầu được thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a task is added note, AntCRM Webhook will push information to the configured Webhook URL)
Ticket (Phiếu yêu cầu)
Chỉ định (Assign)
Khi Phiếu yêu cầu được phân công AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a new task is assigned, AntCRM Webhook will push information to the configured Webhook URL)
Đơn hàng (Order)
Tạo mới (Create new)
Khi Đơn hàng được tạo mới AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a new order is created, AntCRM Webhook will push information to the configured Webhook URL)
Đơn hàng (Order)
Cập nhật (Update)
Khi Đơn hàng được cập nhật AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a new Order is updated, AntCRM Webhook will push information to the configured Webhook URL)
Đơn hàng (Order)
Thêm ghi chú (Add note)
Khi Giao Đơn hàng thêm ghi chú AntCRM Webhook sẽ đẩy thông tin đến Webhook URL đã cấu hình (When a new Order is added note, AntCRM Webhook will push information to the configured Webhook URL)
2.3. Mô tả tham số (2.3. Parameter description)
Dưới đây là bảng mô tả các tham số của AntCRM Data platform (Below is a table describing the AntCRM Data platform parameters)
eventCode
string
Xem bảng EventCode (View EventCode table)
createdBy
Object
avatar: "/static/avatars/57f2399cd7351a3e75f8aa1a1477998580867"
email:"[email protected]"
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
(Note: Contact is for events of the contact and related to the contact.)
ticket
Object
{TicketId:434
assignedTo:"584a439acdff33ff1756b4df"
createdBy:"584a439acdff33ff1756b4df"
followers:[]
group:"584a4142cdff33ff1756b4d3"
id:"59b290f6820385fd1e26c3e5"
title:"Cai dat pfsense cho van phong moi"}
Chú ý: (Note:)
- Ticket dành cho các event liên quan đến ticket (Ticket is for events related to the ticket.)
- assignTo sẽ được populate để lấy thông tin người / group được assigned (assignTo will be populated to retrieve information about the person or group assigned.))
task
Object
{"taskId":3704,
"assignTo":"5923f118cacbe6ed63bb7bbe",
"createdBy":"57fb8157fa0e60a8625145a8",
"completedBy":"5923f118cacbe6ed63bb7bbe",
"Permit":{"status":1,"users":[]},
"Id":"59ae89d521f7cfa03f02f8eb"
}
Chú ý: (Note:)
- Ticket dành cho các event liên quan đến task (The "Ticket" represents events associated with a task.)
- assignTo sẽ được populate để lấy thông tin người / group được assigned (The assignTo field will be automatically populated with details of the assigned user or group.)
content
string
Chuỗi sẽ hiển thị. Ví dụ:
(The string will display. For example:)
link
string
https://happy.beeiq.co/contacts/57fb8157fa0e60a8625145a8
Bảng eventCode: (eventCode table:)
CONTACT_CREATE
Tạo Khách hàng
CONTACT_CHANGE
Cập nhật Khách hàng
CONTACT_CHANGE_STAGE
Cập nhật trạng thái cho Khách hàng
TICKET_CHANGE
Cập nhật Phiếu yêu cầu
TICKET_CREATE
Tạo Phiếu yêu cầu
TASK_CREATE
Tạo Nhiệm vụ
TASK_CHANGE
Cập nhật Nhiệm vụ
DEAL_CREATE
Tạo Đơn hàng
DEAL_CHANGE
Cập nhật Đơn hàng
NOTE_CREATE
Tao ghi chú
Last updated