Saltar al contenido principal
v1 Suscríbete a los eventos de registros de pipeline para enterarte de cada cambio de un registro de pipeline de tu workspace y del resultado de cada acción de etapa. Cada evento usa la estructura común, y su payload trae el registro como queda después del cambio. Usa la guía de registros de pipeline cuando tu sistema también crea o mueve registros con la API REST.

Tipos de evento

Cada cambio produce un evento, salvo un movimiento a una etapa final, que produce dos: pipeline_record.stage_changed y luego pipeline_record.closed. Los dos traen el mismo payload; el eventId de pipeline_record.closed termina en :closed.

Estructura


Payload

Los campos sin valor no aparecen en el payload, salvo record.values, que siempre está.

Valores del registro

record.values es una lista con un elemento por cada atributo que tiene valor: { "id", "label", "type", "value" }. El id de un atributo nunca cambia, así que un atributo renombrado conserva su id. Lee los valores por id cuando los guardes. Los valores registrados antes de que Bridge describiera los atributos llegan con label y type en null, después de los descritos.

Triggers

Motivos de cierre

reason aparece cuando el movimiento trajo un motivo de cierre, por ejemplo cuando un registro se cierra como perdido con el motivo “Price”. reason.id es el motivo de cierre del pipeline, reason.label su texto y reason.note el texto libre escrito con él. Un movimiento a una etapa final también puede no tener motivo de cierre.

Eventos de acciones de etapa

Las acciones de una etapa corren cada vez que un registro entra a la etapa: cuando se crea en ella, cuando pasa a ella y cuando se reabre en ella. Eso incluye los registros creados de forma masiva, así que una importación grande a una etapa con acciones produce un evento de acción por cada registro y acción. El objeto action de un evento pipeline_action.*:
TRANSFER_TO_TEAM todavía no está soportada. Una etapa que aún la tiene produce pipeline_action.failed con ACTION_NOT_SUPPORTED, o pipeline_action.skipped con NO_OPEN_SESSION cuando el registro no tiene una conversación abierta.

Motivos de omisión

Una acción omitida es un resultado normal: la acción no aplicaba a este registro, así que no se cambió nada. skipReason siempre es un código.

Motivos de falla

failureReason es CODE o CODE: detail. Decide según la parte antes de los dos puntos; el detalle sirve para soporte y su texto puede cambiar. El código es uno de estos:
  • Un código propio de las acciones de etapa, de la lista de abajo.
  • El código de error del dominio de Bridge que rechazó la acción, por ejemplo BRIDGE_TASK_0308 cuando no se pudo crear la tarea.
  • HTTP_<status>, cuando ese dominio respondió sin código de error, por ejemplo HTTP_503.
Se pueden agregar códigos nuevos a las dos listas. El significado de un código existente nunca cambia, así que trata un código desconocido como “no corrió” y sigue procesando.

Entrega y orden

  • La entrega puede duplicarse. Descarta los eventos repetidos como se describe en Recepción de eventos.
  • pipeline_record.closed se envía después de su pipeline_record.stage_changed. Cuando se reintenta una entrega, solo se vuelve a enviar el evento que no se entregó, así que pipeline_record.closed puede llegar más tarde que su pipeline_record.stage_changed.
  • Los eventos de registros distintos no tienen orden. Para un registro, ordena sus eventos por timestamp.
  • Los eventos pipeline_action.* llegan después del pipeline_record.created, pipeline_record.stage_changed o pipeline_record.reopened que corrió las acciones.
  • Los registros que existían antes de suscribirte aparecen con su siguiente cambio.

Ejemplos de payload

Ejemplos de eventos de registro

Ejemplos de eventos de acciones de etapa


Temas relacionados