Processo
O objeto Process captura as informações do processo de uma única instância. Portanto, em uma solução de vendas, cada lead é, na verdade, um processo individual. Da mesma forma, em uma solução de suporte, cada chamado é um processo individual. O esquema que diferencia um lead de um chamado é definido em um objeto de esquema chamado procedure.
Em essência, um processo é definido pelos seguintes campos
estado
O estado do processo. Os estados do processo são definidos pelo modelo da solução ou por você, caso tenha criado a solução. Por exemplo, um processo de lead pode ter estados como New, In-Progress, Converted Um processo de chamado pode ter estados como New, Assigned, Solved
Os estados podem ter um fluxo de dependências definido por um stategraph
status
Cada processo pode ter um dos seguintes status
- OPEN
- COMPLETED
- CANCELLED
Enquanto um processo está em andamento, seu status é OPEN, independentemente do estado.
data
data é um campo json que contém os dados reais que definem uma instância do processo. A chave é o shortId ou o id do atributo do processo. Todas as APIs internas publicam os dados do processo como pares id:value, enquanto as APIs externas publicam os dados como pares shortId:value
Exemplo:
{ "lead_id": "LEAD-910", "source": "web-form", "first_name": "Cixin", "last_name": "Liu", "phone_num": "440123000"}campos
name | tipo de dado | informações do tipo | descrição |
|---|---|---|---|
id | string | uuid | id do processo - gerado automaticamente |
team | string | uuid | id da equipe à qual este processo pertence |
procedure | string | uuid | id do procedure ao qual este processo pertence |
createdBy | string | uuid | id do usuário que criou |
assignedTo | string | uuid | id do usuário atribuído |
belongsTo | string | uuid | id do pod ao qual este processo pertence |
entity | string | uuid | entidade do registro ao qual este processo pertence |
record | string | uuid | id do registro associado a este processo |
status | string | string | status: OPEN, COMPLETED, CANCELLED |
state | string | uuid | id do estado que indica o estado atual deste processo |
data | json |
| objeto JSON id:value que armazena os dados reais |
derivedData | json |
| objeto JSON id:value que armazena os dados derivados |
nextActionAt | number | epoch ms | timestamp que indica quando a próxima ação deve ser realizada neste processo |
completedAt | number | epoch ms | timestamp em que este processo foi marcado como concluído |
primaryBooking | string | uuid | id da reserva principal associada a este processo |
cancelledAt | number | epoch ms | timestamp em que este processo foi marcado como cancelado |
parentProcedure | string | uuid | id do procedimento do processo pai deste processo |
parentProcess | string | uuid | id do processo, caso este processo tenha um processo pai — útil para criar processos hierárquicos |
firstAssignedTo | string | uuid | id do usuário atribuído primeiro a este processo |
firstAssignedAt | number | epoch ms | registro de data e hora em que o processo foi atribuído pela primeira vez |
lastAssignedAt | number | epoch ms | registro de data e hora da última atribuição deste processo |
createdAt | number | epoch ms | registro de data e hora em que o processo foi criado |
updatedAt | number | epoch ms | registro de data e hora em que o processo foi atualizado |
isDeleted | booleano |
| indicador que informa se este processo foi excluído ou não |