Gatilhos

Interface para realizar a configuração de gatilhos para disparar emails e/ou webhooks ao eventos serem disparados dentro do sistema

Visão geral da interface

Ações da interface

Carregar entidades

Esta ação serve para sincronizar as novas entidades disponibilizadas no cadastro de gatilhos. É necessário executá-la antes do primeiro uso da funcionalidade.

Criar um novo gatilho

Para criar um novo gatilho, clique no botão + localizado no topo do grid

O popup abaixo será exibido com o formulário para preenchimento.

Em um mesmo gatilho é possível configurar o envio de mais de um email e webhook, com corpo e destinatários diferentes, no caso do email, e endpoints e headers diferentes, no caso dos webhooks.

Emails

  • Nome de Exibição do Remetente: opcional. Serve como máscara para o nome do remetente padrão da Solução 360º

  • Responder Para: opcional. Serve para configurar um email para ser enviada uma resposta se o destinatários desejar

  • Responder Para (Nome de Exibição): opcional. Serve como máscara para o email do campo Responder Para

Para preencher os destinatários, assunto e corpo do email, clique no botão . O popup abaixo será aberto.

Em alguns casos, será disponibilizado atores da entidade para ser feito o envio do email. Como, por exemplo, no contrato, onde é possível enviar uma email para o gestor ou fiscal do contrato que ocorreu o evento.

No Assunto e Corpo, é possível adicionar informações do registro que ocorreu o evento, essas informações podem ser conferidas clicando no botão "Propriedades disponíveis". Para que a propriedade seja corretamente preenchida no email, é necessário que ela seja colocada da mesma forma que é exibida {NomePropriedade}

Webhooks

  • URL: obrigatório

  • Token: opcional. Serve para os casos em que o endpoint necessita de um Authorization

  • Algoritmo de Criptografia: obrigatório, padrão Nenhum. Se escolhido SHA256, o corpo da requisição será criptografado e enviado como header s360-webhook-signature

  • Secret: opcional. Serve como chave para realizar a criptografia do corpo da requisição. Disponível apenas se o Algoritmo de Criptografia for SHA256

Para configurar os headers da requisição, clique no botão . O popup abaixo será aberto, onde é possível adicionar os headers da requisição, bastando preencher a chave (Key) e o valor (Value) do header.

Exemplo do corpo enviado na requisição

{
  "CreatedOn": "2024-01-16T15:13:03.8660981Z",
  "EntityType": "UnidadeMedida",
  "EventType": "EntityInsertedEvent`1",
  "Entity": {
    "Produtos": [],
    "Indicadores": [],
    "Codigo": "dm3",
    "Nome": "decímetro cúbico",
    "InicioValidade": "2024-01-16T15:13:03.8659105Z",
    "TerminoValidade": "9999-12-31T23:59:59.9999999",
    "Ativo": true,
    "CreationTime": "2024-01-16T15:13:03.8665056Z",
    "CreatorUserId": 1,
    "LastModificationTime": "2024-01-16T15:13:03.8665056Z",
    "LastModifierUserId": 1,
    "DomainEvents": [
      {
        "ChangeType": 1,
        "EntityType": "UnidadeMedida",
        "CreatedOn": "2024-01-16T15:13:03.8660981Z",
        "EventType": "EntityInsertedEvent`1"
      }
    ],
    "RowVersion": "AAAAAAAXEk8=",
    "PropriedadesAdicionais": {},
    "Id": 19
  }
}

Last updated