Hay dos parámetros adicionales que puedes utilizar para filtrar eventos: "value_before"
y "value_after"
.
Los siguientes valores están disponibles para el filtro por valores before/after en este momento:
leads_statuses
– filtrar por la etapa del lead, disponible para el eventolead_status_changed
.responsible_user_id
– filtrar por el usuario responsable, disponible para el eventoentity_responsible_changed
.custom_field_values
– filtrar por el valor del campo enum, disponible para el eventocustom_field_{FIELD_ID}_value_changed
, no debe pasarse más de un tipo de evento.value
– filtrar por el valor exacto, disponible para los campos
nps_rate_added
,sale_field_changed
,name_field_changed
,ltv_field_changed
ycustom_field_value_changed
.
leads_statuses
Este filtro permite pasar los IDs de etapa y de pipeline para obtener solo los eventos de cambio de etapa de los leads requeridos.
Este es un ejemplo de cómo podría verse la solicitud:
filter[value_after][leads_statuses][0][pipeline_id]=12345&filter[value_after][leads_statuses][0][status_id]=99999999
En el ejemplo, obtendremos todos los eventos de cambio de etapa de un lead donde el lead fue movido a la etapa 99999999 del pipeline 12345.
responsible_user_id
Este filtro permite pasar IDs de usuario separados por comas para obtener solo los eventos de cambio de responsable de usuario requeridos.
Este es un ejemplo de cómo podría verse la solicitud:
filter[value_after][responsible_user_id]=5555555
Aquí obtendremos todos los eventos de cambio de usuario responsable para el ID de usuario 5555555.
custom_field_values
Filtrar por el valor del campo enum disponible para el evento custom_field_{FIELD_ID}_value_changed
. No se debe pasar más de un tipo de evento.
Este filtro permite pasar valores de campos enum para obtener solo los eventos de cambio de los valores requeridos.
Este es un ejemplo de cómo podría verse la solicitud:
filter[value_after][custom_field_values]=145&filter[type]=custom_field_777777_value_changed
En el siguiente ejemplo, obtendremos todos los eventos de cambio de valor del campo con el ID 777777 y el ID de enum 145.
value
Este filtro permite pasar valores before/after. Solo está disponible para los siguientes tipos de eventos: nps_rate_added
,
sale_field_changed
, name_field_changed
, ltv_field_changed
, custom_field_value_changed
.
Así es como podría verse la solicitud:
filter[value_after][value]=155&filter[type]=sale_field_changed&filter[entity]=lead
Aquí obtendremos todos los eventos de cambio de venta del lead donde la venta del lead se igualó a 155.
Estructura de datos de value_after/before
Si deseas escribir tus propios scripts para filtrar la lista de eventos, ten en cuenta que la estructura de datos de los campos value_after
y value_before
depende del tipo de evento y puede tener valores diferentes.
- Tipos de eventos:
lead_deleted
,lead_restored
,contact_deleted
,contact_restored
,company_deleted
,company_restored
,entity_merged
,task_added
,task_deleted
,task_completed
.
Parámetro | Descripción | Tipe |
---|---|---|
value_after|value_before | Arreglo vacío. | array |
{
"value_after": [],
"value_before": []
}
- Tipo de evento:
task_text_changed
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after|value_before[task] | obj | Objeto de datos de la tarea cambiados. |
value_after|value_before[task][text] | string | Texto de la tarea. |
{
"value_after": [
{
"task": {
"text": "new task text"
}
}
],
"value_before": [
{
"task": {
"text": "old task text"
}
}
]
}
- Tipos de eventos:
robot_replied
yintent_identified
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after[helpbot] | obj | Objeto de datos de intención disparada. |
value_after[helpbot][text] | string | Texto de la tarea. |
{
"value_after": [
{
"helpbot": {
"id": 145
}
}
]
}
- Tipo de evento:
transaction_added
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after[transaction] | obj | Objeto de datos de la transacción. |
value_after[transaction][id] | int | ID de la transacción. |
{
"value_after": [
{
"transaction": {
"id": 33675
}
}
]
}
- Tipos de eventos:
lead_added
,contact_added
,company_added
,common_note_added
,common_note_deleted
,attachment_note_added
,targeting_in_note_added
,targeting_out_note_added
,geo_note_added
,service_note_added
,site_visit_note_added
,message_to_cashier_note_added
,incoming_call
,outgoing_call
,incoming_sms
,outgoing_sms
,link_followed
,task_result_added
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after[note] | obj | Objeto de datos de la nota. |
value_after[note][id] | int | ID de la nota. |
{
"value_after": [
{
"note": {
"id": 7422564
}
}
]
}
- Tipo de evento:
nps_rate_added
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after[nps] | obj | Objeto de datos NPS. |
value_after[nps][rate] | int | Calificación de 1 a 10. |
{
"value_after": [
{
"nps": {
"rate": 7
}
}
]
}
- Tipos de eventos:
incoming_chat_message
youtgoing_chat_message
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after[message] | obj | Objeto de datos del mensaje. |
value_after[message][id] | string | ID del mensaje. |
{
"value_after": [
{
"message": {
"id": "1508b51c-aab0-428e-9322-611d847ae747"
}
}
]
}
- Tipos de eventos:
entity_tag_added
yentity_tag_deleted
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento. |
value_after|value_before[tag] | obj | Objeto de datos de la etiqueta. |
value_after|value_before[tag][name] | string | Nombre de la etiqueta. |
{
"value_after": [
{
"tag": {
"name": "tag 1"
}
}
],
"value_before": [
{
"tag": {
"name": "tag2"
}
},
{
"tag": {
"name": "tag2"
}
}
]
}
- Tipo de evento:
lead_status_changed
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento. |
value_after|value_before[lead_status] | obj | Objeto de datos del estado. |
value_after|value_before[lead_status][id] | int | ID del estado. |
value_after|value_before[lead_status][pipeline_id] | int | ID del pipeline. |
{
"value_after": [
{
"lead_status": {
"id": 5233224,
"pipeline_id": 437642,
}
}
],
"value_before": [
{
"lead_status": {
"id": 5233224,
"pipeline_id": 437642,
}
}
]
}
- Tipos de eventos:
company_linked
,company_unlinked
,contact_linked
,contact_unlinked
,lead_linked
,lead_unlinked
,entity_linked
,entity_unlinked
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo). |
value_after|value_before[link][type] | string | Tipo de entidad. |
value_after|value_before[link][id] | int | ID de la entidad. |
value_after|value_before[unlink][type] | string | Tipo de entidad. |
value_after|value_before[unlink][id] | int | ID de la entidad. |
{
"value_after": [
{
"link": {
"entity": {
"type": "lead",
"id": 6232965
}
}
}
],
"value_before": []
}
- Tipo de evento:
entity_responsible_changed
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento. |
value_after|value_before[responsible_user] | obj | Objeto de datos del usuario. |
value_after|value_before[responsible_user][id] | int | ID del usuario. |
{
"value_after": [
{
"responsible_user": {
"id": 504329
}
}
],
"value_before": [
{
"responsible_user": {
"id": 37268
}
}
]
}
- Tipo de evento:
task_deadline_changed
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento. |
value_after|value_before[task_deadline] | obj | Objeto de datos de la fecha límite de la tarea. |
value_after|value_before[task_deadline][timestamp] | int | Marca de tiempo de la fecha límite. |
{
"value_after": [
{
"task_deadline": {
"timestamp": 1573595900
}
}
],
"value_before": [
{
"task_deadline": {
"timestamp": 1573578700
}
}
]
}
- Tipo de evento:
task_type_changed
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento. |
value_after|value_before[task_type] | obj | Objeto de datos del tipo de tarea. |
value_after|value_before[task_type][id] | int | ID del tipo de tarea. |
{
"value_after": [
{
"task_type": {
"id": 504329
}
}
],
"value_before": [
{
"task_type": {
"id": 37268
}
}
]
}
- Tipo de evento:
custom_field_value_changed
.
Parámetro | Tipo | Descripción |
---|---|---|
value_after|value_before | array | Arreglo de cambios del evento. |
value_after|value_before[custom_field_value][field_id] | int | ID del campo. |
value_after|value_before[custom_field_value][field_type] | int | ID del tipo de tarea. |
value_after|value_before[custom_field_value][enum_id] | int|null | ID del valor de enum o null si el campo no tiene valores enum. |
value_after|value_before[custom_field_value][text] | string | Texto del valor del campo. |
{
"value_after": [
{
"custom_field_value": {
"field_id": 53728,
"field_type": 8,
"enum_id": 2352876,
"text": "example1@test.com"
}
},
{
"custom_field_value": {
"field_id": 53728,
"field_type": 8,
"enum_id": 2352876,
"text": "example@test.com"
}
}
],
"value_before": [
{
"custom_field_value": {
"field_id": 53728,
"field_type": 8,
"enum_id": 193200,
"text": "example@test.com"
}
}
]
}