Pular para o conteúdo principal
v1 Assine os eventos de registros de pipeline para saber de cada mudança de um registro de pipeline do seu workspace e do resultado de cada ação de etapa. Cada evento usa a estrutura comum, e o seu payload traz o registro como fica depois da mudança. Use o guia de registros de pipeline quando o seu sistema também cria ou move registros pela API REST.

Tipos de evento

Cada mudança produz um evento, exceto uma movimentação para uma etapa final, que produz dois: pipeline_record.stage_changed e depois pipeline_record.closed. Os dois trazem o mesmo payload; o eventId de pipeline_record.closed termina em :closed.

Estrutura


Payload

Os campos sem valor não aparecem no payload, exceto record.values, que está sempre presente.

Valores do registro

record.values é uma lista com um item para cada atributo que tem valor: { "id", "label", "type", "value" }. O id de um atributo nunca muda, então um atributo renomeado mantém o seu id. Leia os valores pelo id quando os armazenar. Os valores registrados antes de o Bridge descrever os atributos chegam com label e type em null, depois dos descritos.

Triggers

Motivos de fechamento

reason aparece quando a movimentação trouxe um motivo de fechamento, por exemplo quando um registro é fechado como perdido com o motivo “Price”. reason.id é o motivo de fechamento do pipeline, reason.label o seu texto e reason.note o texto livre escrito com ele. Uma movimentação para uma etapa final também pode não ter motivo de fechamento.

Eventos de ações de etapa

As ações de uma etapa são executadas cada vez que um registro entra na etapa: quando é criado nela, quando passa para ela e quando é reaberto nela. Isso inclui os registros criados em massa, então uma importação grande para uma etapa com ações produz um evento de ação para cada registro e ação. O objeto action de um evento pipeline_action.*:
TRANSFER_TO_TEAM ainda não é suportada. Uma etapa que ainda a tem produz pipeline_action.failed com ACTION_NOT_SUPPORTED, ou pipeline_action.skipped com NO_OPEN_SESSION quando o registro não tem uma conversa aberta.

Motivos para ignorar

Uma ação ignorada é um resultado normal: a ação não se aplicava a este registro, então nada foi alterado. skipReason é sempre um código.

Motivos de falha

failureReason é CODE ou CODE: detail. Decida pela parte antes dos dois-pontos; o detalhe ajuda o suporte e o seu texto pode mudar. O código é um destes:
  • Um código das próprias ações de etapa, da lista abaixo.
  • O código de erro do domínio do Bridge que recusou a ação, por exemplo BRIDGE_TASK_0308 quando não foi possível criar a tarefa.
  • HTTP_<status>, quando esse domínio respondeu sem código de erro, por exemplo HTTP_503.
Novos códigos podem ser adicionados às duas listas. O significado de um código existente nunca muda, então trate um código desconhecido como “não foi executada” e continue processando.

Entrega e ordem

  • A entrega pode ser duplicada. Descarte os eventos repetidos como descrito em Recebimento de eventos.
  • pipeline_record.closed é enviado depois do seu pipeline_record.stage_changed. Quando uma entrega é repetida, só o evento que não foi entregue é reenviado, então pipeline_record.closed pode chegar depois do seu pipeline_record.stage_changed.
  • Os eventos de registros diferentes não têm ordem. Para um registro, ordene os seus eventos por timestamp.
  • Os eventos pipeline_action.* chegam depois do pipeline_record.created, pipeline_record.stage_changed ou pipeline_record.reopened que executou as ações.
  • Os registros que existiam antes da assinatura aparecem com a sua próxima mudança.

Exemplos de payload

Exemplos de eventos de registro

Exemplos de eventos de ações de etapa


Tópicos relacionados