Webhooks

Sumário

1. Conceito

Webhook é uma ferramenta que permite a comunicação entre aplicações, enviando dados automaticamente entre elas por meio do protocolo HTTP.

Os webhooks são acionados por eventos específicos, após a inscrição de um participante em um evento. Eles podem ser usados para automatizar a comunicação entre aplicações e para ativar fluxos de trabalho.

Os webhooks são diferentes das APIs. Enquanto a API permite recuperar/inserir/alterar/remover dados, o webhook permite que os dados sejam enviados pelo próprio aplicativo assim que o evento ocorre.

Para mais informações referentes ao webhook, suas funcionalidades em geral, como registrar, obter, remover, ou testar webhook, acesse ao nossa documentação completa, clicando aqui.

2. Eventos

PROCESS_STARTED_NOTIFICATION (Processo iniciado)

• Quando é acionado: Quando uma nova solicitação é iniciada
  • Campos Enviados:
    • Contexto do Fluxo: context_flow
    • Token de Autorização: authorization
    • Tipo do Evento: ProcessStartedNotification
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Próximas Etapas: next_steps
    • Tenant: tenant
    • Usuário Logado: current_user

PROCESS_CANCELED_NOTIFICATION (Processo cancelado)

• Quando é acionado: Quando um processo é cancelado
  • Campos Enviados:
    • Contexto do Fluxo: context_flow
    • Token de Autorização: authorization
    • Tipo do Evento: ProcessCanceledNotification
    • Id do Processo: process_id
    • Versão do Processo: process_version
    • Nome do Processo: process_name
    • Cancelado por: canceled_by
    • Cancelado em: canceled_at yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Próximas Etapas: next_steps
    • Tenant: tenant
    • Usuário Logado: current_user

PROCESS_ENDED_NOTIFICATION (Processo encerrado)

• Quando é acionado: Quando um processo é encerrado
  • Campos Enviados:
    • Contexto do fluxo: context_flow
    • Token de Autorização: authorization
    • Tipo do Evento: ProcessEndedNotification
    • Id do Processo: process_id
    • Versão do Processo: process_version
    • Nome do Processo: process_name
    • Id da Instância do Processo: process_instance_id
    • Tenant: tenant
    • Usuário Logado: current_user

NEW_PENDENCY_NOTIFICATION (Nova pendência)

• Quando é acionado: Quando uma nova pendência é criada
  • Campos Enviados:
    • Contexto do Fluxo: context_flow
    • Token de Autorização: authorization
    • Tipo do Evento: NewPendencyNotification
    • Id do Processo: process_id
    • Versão do Processo: process_version
    • Nome do Processo: process_name
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Etapa Atual: current_step
    • Status da Pendência Atual: process_status
    • Data de Expiração: expire_date yyyy-MM-dd’T’HH:mm:ss
    • Data que a Pendência foi Criada: start_date yyyy-MM-dd’T’HH:mm:ss
    • Próximas Etapas: next_steps
    • Tenant: tenant
    • Usuário Logado: current_user

PENDENCY_DELETED_NOTIFICATION (Tarefa deletada)

• Quando é acionado: Quando uma tarefa é deletada
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: PendencyDeletedNotification
    • Id do Processo: process_id
    • Data em que foi Deletado: deleted_in yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Usuário que Deletou: deleted_by
    • Tenant: tenant

PENDENCY_ENDED_NOTIFICATION (Conclusão de uma tarefa)

• Quando é acionado: Quando uma tarefa é concluída
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: PendencyEndedNotification
    • Id do Processo: process_id
    • Data em que a Tarefa foi Concluída: end_date yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Usuário Solicitante: requester_user
    • Responsável pela Tarefa: responsible_for_task
    • Tenant: tenant
    • Usuário Logado: current_user

BEFORE_PENDENCY_EXPIRE_NOTIFICATION (Antes de expirar)

• Quando é acionado: Quando uma pendência está prestes a expirar
  • Campos Enviados:
    • Contexto do Fluxo: context_flow
    • Tipo do Evento: BeforePendencyExpireNotification
    • Id do Processo: process_id
    • Versão do Processo: process_version
    • Nome do Processo: process_name
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Etapa Atual: current_step
    • Status da Pendência Atual: process_status
    • Data de Expiração: expire_date yyyy-MM-dd’T’HH:mm:ss
    • Data que a Pendência foi Criada: start_date yyyy-MM-dd’T’HH:mm:ss
    • Próximas Etapas: next_steps
    • Tenant: tenant
    • Usuário Logado: current_user

PENDENCY_EXPIRED_NOTIFICATION (Pendência expirada)

• Quando é acionado: Quando a pendência expira
  • Campos Enviados:
    • Contexto do Fluxo: context_flow
    • Tipo do Evento: PendencyExpiredNotification
    • Id do Processo: process_id
    • Versão do Processo: process_version
    • Nome do Processo: process_name
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Etapa Atual: current_step
    • Status da Pendência Atual: process_status
    • Data de Expiração: expire_date yyyy-MM-dd’T’HH:mm:ss
    • Data que a Pendência foi Criada: start_date yyyy-MM-dd’T’HH:mm:ss
    • Próximas Etapas: next_steps
    • Tenant: tenant
    • Usuário Logado: current_user

EXPIRATION_DATE_CHANGED_NOTIFICATION (Data de expiração alterada)

• Quando é acionado: Quando a data de expiração de uma pendência é alterada
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: ExpirationDateChangedNotification
    • Id do Processo: process_id
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Etapa Atual: current_step
    • Status da Pendência Atual: process_status
    • Data de Expiração: expire_date yyyy-MM-dd’T’HH:mm:ss
    • Data de Expiração Anterior: last_expiration_date yyyy-MM-dd’T’HH:mm:ss
    • Data que a Pendência foi Criada: start_date yyyy-MM-dd’T’HH:mm:ss
    • Id do Usuário que fez a Alteração: update_user
    • Data em que a Alteração foi Feita: update_date yyyy-MM-dd’T’HH:mm:ss
    • Próximas Etapas: next_steps
    • Tenant: tenant
    • Usuário Logado: current_user

RESPONSIBLE_CHANGED_NOTIFICATION (Alteração do responsável)

• Quando é acionado: Quando o responsável por uma tarefa é alterado
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: ResponsibleChangedNotification
    • Id do Processo: process_id
    • Data da Alteração: change_date yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Responsável Anterior: old_responsible
    • Novo Responsável: new_responsible
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Tenant: tenant
    • Usuário Logado: current_user

REQUESTER_CHANGED_NOTIFICATION (Alteração do solicitante)

• Quando é Acionado: Quando o solicitante de uma solicitação é alterado
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: RequesterChangedNotification
    • Id do Processo: process_id
    • Data da Alteração: change_date yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Solicitante Anterior: old_requester
    • Novo Solicitante: new_requester
    • Tenant: tenant
    • Usuário Logado: current_user

ATTACHMENT_ADDED_NOTIFICATION (Arquivo adicionado)

• Quando é acionado: Quando um arquivo é adicionado na aba de anexos de uma tarefa
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: AttachmentAddedNotification
    • Id do Processo: process_id
    • Data em que o Anexo foi Adicionado: created_date yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Id do Anexo: attachment_id
    • Nome do Anexo: attachment_name
    • Tenant: tenant
    • Usuário Logado: current_user

COMMENT_ADDED_NOTIFICATION (Comentário adicionado na tarefa)

• Quando é acionado: Quando um comentário é adicionado a uma tarefa
  • Campos Enviados:
    • Token de Autorização: authorization
    • Tipo do Evento: CommentAddedNotification
    • Id do Processo: process_id
    • Data em que Comentário foi Adicionado: created yyyy-MM-dd’T’HH:mm:ss
    • Id da Instância do Processo: process_instance_id
    • Id da Atividade Atual: activity_id
    • Id da Etapa Atual: step_id
    • Status da Pendência Atual: process_status
    • Data que a Pendência foi Criada: start_date yyyy-MM-dd’T’HH:mm:ss
    • Comentário Feito: comment
    • Etapa Atual: current_step
    • Tenant: tenant
    • Usuário Logado: current_use