Filtrar eventos

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 evento lead_status_changed.
  • responsible_user_id – filtrar por el usuario responsable, disponible para el evento entity_responsible_changed.
  • custom_field_values – filtrar por el valor del campo enum, disponible para el evento custom_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 y custom_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ámetroDescripciónTipe
value_after|value_beforeArreglo vacío.array
{
    "value_after": [],
    "value_before": []
}
  • Tipo de evento: task_text_changed.
ParámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after|value_before[task]objObjeto de datos de la tarea cambiados.
value_after|value_before[task][text]stringTexto de la tarea.
{
    "value_after": [
          {
            "task": {
              "text": "new task text"
            }
          }
        ],
    "value_before": [
          {
            "task": {
              "text": "old task text"
            }
          }
        ]
}
  • Tipos de eventos: robot_replied y intent_identified.
ParámetroTipoDescripción
value_afterarrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after[helpbot]objObjeto de datos de intención disparada.
value_after[helpbot][text]stringTexto de la tarea.
{
    "value_after": [
          {
            "helpbot": {
              "id": 145
            }
          }
        ]
}
  • Tipo de evento: transaction_added.
ParámetroTipoDescripción
value_afterarrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after[transaction]objObjeto de datos de la transacción.
value_after[transaction][id]intID 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ámetroTipoDescripción
value_afterarrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after[note]objObjeto de datos de la nota.
value_after[note][id]intID de la nota.
{
    "value_after": [
          {
            "note": {
              "id": 7422564
            }
          }
        ]
}
  • Tipo de evento: nps_rate_added.
ParámetroTipoDescripción
value_afterarrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after[nps]objObjeto de datos NPS.
value_after[nps][rate]intCalificación de 1 a 10.
{
    "value_after": [
          {
            "nps": {
              "rate": 7
            }
          }
        ]
}
  • Tipos de eventos: incoming_chat_message y outgoing_chat_message.
ParámetroTipoDescripción
value_afterarrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after[message]objObjeto de datos del mensaje.
value_after[message][id]stringID del mensaje.
{
    "value_after": [
          {
            "message": {
              "id": "1508b51c-aab0-428e-9322-611d847ae747"
            }
          }
        ]
}
  • Tipos de eventos: entity_tag_added y entity_tag_deleted.
ParámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento.
value_after|value_before[tag]objObjeto de datos de la etiqueta.
value_after|value_before[tag][name]stringNombre de la etiqueta.
{
    "value_after": [
          {
            "tag": {
              "name": "tag 1"
            }
          }
        ],
    "value_before": [
          {
            "tag": {
              "name": "tag2"
            }
          },
          {
            "tag": {
              "name": "tag2"
            }
          }
        ]
}
  • Tipo de evento: lead_status_changed.
ParámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento.
value_after|value_before[lead_status]objObjeto de datos del estado.
value_after|value_before[lead_status][id]intID del estado.
value_after|value_before[lead_status][pipeline_id]intID 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ámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento (este tipo de evento siempre tiene un cambio en el arreglo).
value_after|value_before[link][type]stringTipo de entidad.
value_after|value_before[link][id]intID de la entidad.
value_after|value_before[unlink][type]stringTipo de entidad.
value_after|value_before[unlink][id]intID de la entidad.
{
    "value_after": [
          {
            "link": {
              "entity": {
                "type": "lead",
                "id": 6232965
              }
            }
          }
        ],
    "value_before": []
}
  • Tipo de evento: entity_responsible_changed.
ParámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento.
value_after|value_before[responsible_user]objObjeto de datos del usuario.
value_after|value_before[responsible_user][id]intID del usuario.
{
    "value_after": [
          {
            "responsible_user": {
              "id": 504329
            }
          }
        ],
    "value_before": [
          {
            "responsible_user": {
              "id": 37268
            }
          }
        ]
}
  • Tipo de evento: task_deadline_changed.
ParámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento.
value_after|value_before[task_deadline]objObjeto de datos de la fecha límite de la tarea.
value_after|value_before[task_deadline][timestamp]intMarca 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ámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento.
value_after|value_before[task_type]objObjeto de datos del tipo de tarea.
value_after|value_before[task_type][id]intID del tipo de tarea.
{
    "value_after": [
          {
            "task_type": {
              "id": 504329
            }
          }
        ],
    "value_before": [
          {
            "task_type": {
              "id": 37268
            }
          }
        ]
}
  • Tipo de evento: custom_field_value_changed.
ParámetroTipoDescripción
value_after|value_beforearrayArreglo de cambios del evento.
value_after|value_before[custom_field_value][field_id]intID del campo.
value_after|value_before[custom_field_value][field_type]intID del tipo de tarea.
value_after|value_before[custom_field_value][enum_id]int|nullID del valor de enum o null si el campo no tiene valores enum.
value_after|value_before[custom_field_value][text]stringTexto 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"
      }
    }
  ]
}