Referências de API
🇺🇸

Filtragem de eventos

Há dois parâmetros adicionais que você pode usar para a filtragem de eventos: "value_before" e "value_after".

Os seguintes valores estão disponíveis para o filtro por valores antes/depois no momento:

  • leads_statuses – filtra pela etapa do lead, disponível para o eventolead_status_changed event
  • responsible_user_id – filtra pelo usuário responsável, disponível para o evento entity_responsible_changed event
  • custom_field_values – filtra pelo valor do campo enum, disponível para o evento custom_field_{FIELD_ID}_value_changed event, no more than 1 event type should be passed
  • value – filtra pelo valor exato, disponível para os eventos
    nps_rate_added, sale_field_changed, name_field_changed, ltv_field_changed, custom_field_value_changed events

leads_statuses

Esse filtro permite passar IDs de etapas e pipelines para obter apenas os eventos de mudança de estágio de lead necessários.

Veja como pode ser a requisição:

filter[value_after][leads_statuses][0][pipeline_id]=12345&filter[value_after][leads_statuses][0][status_id]=99999999

No exemplo, obteremos todos os eventos de mudança de estágio de lead onde o lead foi movido para o estágio 99999999 do pipeline 12345.

responsible_user_id

Esse filtro permite passar IDs de usuários separados por vírgulas para obter apenas os eventos de mudança de usuário responsável necessários.

Veja como pode ser a requisição:

filter[value_after][responsible_user_id]=5555555

Aqui obteremos todos os eventos de mudança de usuário responsável para o ID de usuário 5555555.

custom_field_values

Filtra pelo valor do campo enum disponível para o evento custom_field_{FIELD_ID}_value_changed, não deve ser passado mais de 1 tipo de evento.

Esse filtro permite passar valores de campo enum para obter apenas os eventos de mudança de valores de campo necessários.

Veja como pode ser a requisição:

filter[value_after][custom_field_values]=145&filter[type]=custom_field_777777_value_changed

No seguinte exemplo, obteremos todos os eventos de mudança de valor de campo para o campo ID 777777 com enum ID 145.

value

Esse filtro permite passar valores antes/depois. Ele está disponível apenas para os seguintes tipos de evento: nps_rate_added,
sale_field_changed, name_field_changed, ltv_field_changed, custom_field_value_changed.

Veja como pode ser a requisição:

filter[value_after][value]=155&filter[type]=sale_field_changed&filter[entity]=lead

Aqui obteremos todos os eventos de mudança de valor de venda de lead onde o valor da venda do lead passou a ser igual a 155.

Estrutura dos dados de value_after/before

Se você deseja escrever seus próprios scripts para filtrar a lista de eventos, lembre-se de que a estrutura de dados dos campos value_after e value_before depende do tipo de evento e pode ter valores diferentes.

  • Tipos de Evento: lead_deleted, lead_restored, contact_deleted, contact_restored, company_deleted, company_restored, entity_merged, task_added, task_deleted, task_completed
ParâmetroTipoDescrição
value_after|value_beforearrayArray vazio
{
    "value_after": [],
    "value_before": []
}
  • Tipo de evento: task_text_changed
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after|value_before[0][task]objObjeto de dados da tarefa alterada
value_after|value_before[0][task][text]stringTexto da tarefa
{
    "value_after": [
          {
            "task": {
              "text": "new task text"
            }
          }
        ],
    "value_before": [
          {
            "task": {
              "text": "old task text"
            }
          }
        ]
}
  • Tipos de evento: robot_replied e intent_identified
ParâmetroTipoDescrição
value_afterarrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after[0][helpbot]objObjeto de dados da intenção acionada
value_after[0][helpbot][text]stringTexto da tarefa
{
    "value_after": [
          {
            "helpbot": {
              "id": 145
            }
          }
        ]
}
  • Tipos de evento: transaction_added
ParâmetroTipoDescrição
value_afterarrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after[0][transaction]objObjeto de dados da transação
value_after[0][transaction][id]intID da transação
{
    "value_after": [
          {
            "transaction": {
              "id": 33675
            }
          }
        ]
}
  • Tipos de evento: 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âmetroTipoDescrição
value_afterarrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after[0][note]objObjeto de dados da nota
value_after[0][note][id]intID da anotação
{
    "value_after": [
          {
            "note": {
              "id": 7422564
            }
          }
        ]
}
  • Tipo de evento: nps_rate_added
ParâmetroTipoDescrição
value_afterarrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after[0][nps]objObjeto de dados da nota NPS
value_after[0][nps][rate]intNota de 1 a 10
{
    "value_after": [
          {
            "nps": {
              "rate": 7
            }
          }
        ]
}
  • Tipos de evento: incoming_chat_message e outgoing_chat_message
ParâmetroTipoDescrição
value_afterarrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after[0][message]objObjeto de dados da mensagem
value_after[0][message][id]stringID da Mensagem
{
    "value_after": [
          {
            "message": {
              "id": "1508b51c-aab0-428e-9322-611d847ae747"
            }
          }
        ]
}
  • Tipos de evento: entity_tag_added e entity_tag_deleted
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento
value_after|value_before[0][tag]objObjeto de dados da tag
value_after|value_before[0][tag][name]stringNome da tag
{
    "value_after": [
          {
            "tag": {
              "name": "tag 1"
            }
          }
        ],
    "value_before": [
          {
            "tag": {
              "name": "tag2"
            }
          },
          {
            "tag": {
              "name": "tag2"
            }
          }
        ]
}
  • Tipo de evento: lead_status_changed
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento
value_after|value_before[0][lead_status]objObjeto de dados do status
value_after|value_before[0][lead_status][id]intID do status
value_after|value_before[0][lead_status][pipeline_id]intID da pipeline
{
    "value_after": [
          {
            "lead_status": {
              "id": 5233224,
              "pipeline_id": 437642,
            }
          }
        ],
    "value_before": [
          {
            "lead_status": {
              "id": 5233224,
              "pipeline_id": 437642,
            }
          }
        ]
}
  • Tipos de evento: company_linked, company_unlinked, contact_linked, contact_unlinked, lead_linked, lead_unlinked, entity_linked, entity_unlinked
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento (este tipo de evento sempre tem uma alteração no array).
value_after|value_before[0][link][entity][type]stringTipo de entidade
value_after|value_before[0][link][entity][id]intID da entidade
value_after|value_before[0][unlink][entity][type]stringTipo de entidade
value_after|value_before[0][unlink][entity][id]intID da entidade
{
    "value_after": [
          {
            "link": {
              "entity": {
                "type": "lead",
                "id": 6232965
              }
            }
          }
        ],
    "value_before": []
}
  • Tipo de evento: entity_responsible_changed
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento
value_after|value_before[0][responsible_user]objObjeto de dados do usuário
value_after|value_before[0][responsible_user][id]intID do usuário
{
    "value_after": [
          {
            "responsible_user": {
              "id": 504329
            }
          }
        ],
    "value_before": [
          {
            "responsible_user": {
              "id": 37268
            }
          }
        ]
}
  • Tipo de evento: task_deadline_changed
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento
value_after|value_before[0][task_deadline]objObjeto de dados do prazo da tarefa
value_after|value_before[0][task_deadline][timestamp]intCarimbo de data e hora do prazo
{
    "value_after": [
          {
            "task_deadline": {
              "timestamp": 1573595900
            }
          }
        ],
    "value_before": [
          {
            "task_deadline": {
              "timestamp": 1573578700
            }
          }
        ]
}
  • Tipo de evento: task_type_changed
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento
value_after|value_before[0][task_type]objObjeto de dados do tipo de tarefa
value_after|value_before[0][task_type][id]intID do tipo de tarefa
{
    "value_after": [
          {
            "task_type": {
              "id": 504329
            }
          }
        ],
    "value_before": [
          {
            "task_type": {
              "id": 37268
            }
          }
        ]
}
  • Tipo de evento: custom_field_value_changed
ParâmetroTipoDescrição
value_after|value_beforearrayArray de alterações de evento
value_after|value_before[0][custom_field_value][field_id]intID do campo
value_after|value_before[0][custom_field_value][field_type]intID do tipo de tarefa
value_after|value_before[0][custom_field_value][enum_id]int|nullID do valor do enum ou null se o campo não tiver valores enum
value_after|value_before[0][custom_field_value][text]stringTexto do valor do 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"
      }
    }
  ]
}