1. Introduction
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. Configuration instruction
2.1. AntCRM Webhook URL configuration instruction
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:
Step 1: Enter Setting → choose Other setting → choose Webhook
Step 2: Choose Webhook Tab
Step 3: Enter URL of the system that you want to export data
Step 4: Configure the condition to AntCRM Data Platform send the event out → choose Thêm Webhook
Note: View section 2.2. The event of AntCRM Webhook to learn about the details of the events that AntCRM Data Platform provides.
After adding new Webhook URL, AntCRM Data Platform interface will display as follow:
2.2. Event of AntCRM Webhook
AntCRM Webhook events support to push information out, described below:
Information field | Event | Description |
Contact | Create new | When a new contact is created, AntCRM Webhook will push information to the configured Webhook URL |
Update | When a contact is updated, AntCRM Webhook will push information to the configured Webhook URL |
Add note or comment | When a contact is added note, AntCRM Webhook will push information to the configured Webhook URL |
Task | Create new | When a new task is created, AntCRM Webhook will push information to the configured Webhook URL |
Update | When a task is updated, AntCRM Webhook will push information to the configured Webhook URL |
Add note | When a task is added note, AntCRM Webhook will push information to the configured Webhook URL |
Assign | When a new task is assigned, AntCRM Webhook will push information to the configured Webhook URL |
Ticket | Create new | When a new ticket is created, AntCRM Webhook will push information to the configured Webhook URL |
Update | When a task is updated, AntCRM Webhook will push information to the configured Webhook URL |
Add note | When a task is added note, AntCRM Webhook will push information to the configured Webhook URL |
Assign | When a task is assigned, AntCRM Webhook will push information to the configured Webhook URL |
Order | Create new | When a new order is created, AntCRM Webhook will push information to the configured Webhook URL |
Update | When a new ticket is updated, AntCRM Webhook will push information to the configured Webhook URL |
Add note | When a new ticket is added note, AntCRM Webhook will push information to the configured Webhook URL |
2.3. Parameter description
Below is a table describing the AntCRM Data platform parameters
Field Name | Type | Description |
eventCode | string | View EventCode table |
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"}
Note: - Tickets are for events related to tickets - assignTo will be populated to get the assigned person/group information |
task | Object | {"taskId":3704, "assignTo":"5923f118cacbe6ed63bb7bbe", "createdBy":"57fb8157fa0e60a8625145a8", "completedBy":"5923f118cacbe6ed63bb7bbe", "Permit":{"status":1,"users":[]}, "Id":"59ae89d521f7cfa03f02f8eb" }
Note: - Tickets are for events related to tickets - assignTo will be populated to get the assigned person/group information |
content | string | The string will display. For example:
|
link | string | https://happy.beeiq.co/contacts/57fb8157fa0e60a8625145a8 |
eventCode table:
Event | Description |
CONTACT_CREATE | Create contact |
CONTACT_CHANGE | Update contact |
CONTACT_CHANGE_STAGE | Update stage for contact |
TICKET_CHANGE | Update ticket |
TICKET_CREATE | Create ticket |
TASK_CREATE | Create task |
TASK_CHANGE | Update task |
DEAL_CREATE | Create deal |
DEAL_CHANGE | Update deal |
NOTE_CREATE | Create note |