Webhook Credentials

A aba WEBHOOK CREDENTIALS (Integrations  WEBHOOK CREDENTIALS) lista credenciais de autenticação utilizadas pelo Flexible Actions para enviar requisições para endpoints cadastrados. Essas requisições são uma das opções para envio de notificações quando um alerta é disparado e são configuradas na etapa ACTIONS de criação de um alerta (tanto em Platform Events quanto em Runtime Alerts), dentro da opção Webhook .

As credenciais podem ser constituídas de client ID ou client ID + secret. Sua configuração também inclui a localização em que as informações serão trafegadas na requisição (que pode ser em header ou query param).

Lista de credenciais

A aba lista todas as credenciais de webhook existentes no Flexible Actions, ordenadas por data de última modificação:

int webhook credentials

A tabela de listagem exibe o nome identificador para a credencial, seu tipo (se Client ID ou Client ID and Secret) e data de última modificação em suas configurações. Além disso, a coluna OPTIONS traz dois ícones de ação:

  • icon edit black para editar uma credencial;

  • icon delete black para excluí-la.

    É possível excluir uma credencial mesmo que esteja sendo utilizada nas configurações de webhook de um alerta. Nesse caso, ao consultar a tela de overview do alerta, o webhook será exibido como sem autenticação ("No Auth").

Criação de credenciais

Para criar uma nova credencial, clique no botão + NEW CREDENTIAL no canto superior direito da tela.

Digite um nome para a credencial e escolha o seu tipo: Client ID ou Client ID and Secret. Isso abrirá os outros campos de configuração, que dependem do tipo.

O nome da credencial não precisa ser único, mas se você tiver múltiplas credenciais com o mesmo nome, será difícil selecionar a que deseja quando estiver configurando um webhook em um alerta.

Client ID

Se a sua credencial for do tipo Client ID, preencha:

  • Field Name: nome do campo que estará na requisição (compondo o par nome/valor);

  • Location: localização da informação na requisição, que pode ser Header ou Query Param;

  • Value: valor do client ID, compondo o par nome/valor.
    credential clientid

Quando somente o client ID é utilizado, ele é exibido sem codificação na requisição. Pegando o exemplo da imagem acima, em que o client ID foi cadastrado para ser trafegado no header, o header conterá: clientid: link.

Se o mesmo client ID fosse incluído como query param, teríamos uma requisição POST /?clientid=link.

Depois de salvar sua credencial, ela pode ser utilizada na configuração de um webhook em Platform Events e Runtime Alerts.

Client ID and Secret

Se a sua credencial for do tipo Client ID and Secret, preencha:

  • Field Name: nome do campo que estará na requisição (compondo o par nome/valor);

  • Location: localização da informação na requisição, que pode ser Header ou Query Param;

  • Client ID: valor do client ID, compondo o par nome/valor.

  • Secret: valor que será adicionado ao client ID.
    credential clientid secret

Quando o client ID é utilizado acompanhado de secret, o valor trafegado na requisição é composto por ambos client ID e secret, codificados em Base64. Pegando o exemplo da imagem acima, em que o valor de client ID + secret foi cadastrado para ser trafegado no header, o header conterá: clientid: bGlua2Vwb25h.

Se o mesmo client ID fosse incluído como query param, teríamos uma requisição POST /?clientid=bGlua2Vwb25h.

Depois de salvar sua credencial, ela pode ser utilizada na configuração de um webhook em Platform Events e Runtime Alerts.

Edição de credenciais

Para editar uma credencial, clique em icon edit black na coluna OPTIONS da lista de credenciais existentes, o que levará a uma tela de cadastro igual à de criação da credencial.

Você pode editar quaisquer campos de uma credencial, exceto o tipo (Client ID ou Client ID and Secret). Nesse caso, é necessário excluir a credencial e criar uma nova.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]