Criando e gerenciando webhooks para fluxos de trabalho

Como funcionam os webhooks

Quando um evento acontece no Qlik Cloud (por exemplo, um novo aplicativo é criado ou um usuário é excluído), um webhook envia informações no formato JSON para um aplicativo externo especificado usando um callback HTTP. Esse aplicativo externo então pode usar os dados do evento para acionar outras ações.

Por exemplo:

• Notifique sua equipe pelo Slack quando um novo aplicativo for criado.

• Envie automaticamente um e-mail de boas-vindas quando um novo membro da equipe for adicionado a um locatário.

• Atualize uma planilha quando um usuário for excluído do locatário.

Benefícios do uso de webhooks

Os webhooks permitem a integração em tempo real com outros sistemas, eliminando a necessidade de verificações manuais constantes ou solicitações de API repetitivas. Ao escutar eventos e enviar os dados relevantes imediatamente, os webhooks reduzem o trabalho desnecessário e permitem uma automação suave.

Plataformas populares para integrações de webhooks

Para manipular e responder a dados de webhooks, você pode criar serviços personalizados ou usar plataformas de terceiros, como:

• Qlik Application Automation (somente em inglês)

• Pipedream

• Zapier

• Microsoft Power Automate

Limites de webhooks

Para manter o desempenho do sistema e gerenciar recursos, os seguintes limites se aplicam:

• O histórico de entrega do webhook é retido por 7 dias.

• Cada usuário pode ter até 150 webhooks.

• No máximo 100 webhooks podem ser criados por locatário.

https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx

{
    "Content-Type": "application/json",
    "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
    "User-Agent": "Qlik Webhook"
}

{
    "cloudEventsVersion": "0.1",
    "source": "com.qlik/engine",
    "contentType": "application/json",
    "eventId": "e65c1481-e8a-4be-a5ca-27dfcde077d7",
    "eventTime": "2021-03-08T14:51:29Z",
    "eventTypeVersion": "1.0.0",
    "eventType": "com.qlik.v1.app.deleted",
    "extensions": {
        "ownerId": "vNRGrDZIypJzauw59BbpvkRhqbmI",
        "tenantId": "oZcMPa_1PwH4FUdrh6839YHHdEJN",
        "userId": "vNRGrDZIypJtcGTzauw59BbpqbmI"
    },
    "data": {
        "attributes": {
            "id": "0984fec4-aa8c-4253-b1d1-4fd4f9c78",
            "name": "New App",
            "createdDate": "2021-03-08T14:51:28.888Z",
            "modifiedDate": "2021-03-08T14:51:29.316Z",
            "owner": "auth0|b62a17c577a4abe6e807b07d18c4d82286352542d633d120100b03fb11",
            "ownerId": "vNRGrDZIypJtcGTzauw59BbpvbmI",
            "published": false,
            "hasSectionAccess": false
        }
    }
}

Criando webhooks

Webhooks podem ser criados por:

• Administrador de locatários do centro de atividades de Administração.

• Todos os usuários da interface do Qlik Application Automation.

Para obter mais informações sobre o uso de webhooks com o Application Automation, consulte Trabalhando com webhooks (somente em inglês).

Faça o seguinte:

1. No centro de atividades de Administração, acesse Webhooks.

2. Clique em Criar novo.

3. Insira um nome para o webhook e, opcionalmente, adicione uma descrição.

4. Para a URL (endpoint), insira o nome de domínio totalmente qualificado (FQDN) para o qual o webhook enviará dados JSON.

   • Essa URL deve usar o protocolo HTTPS (exemplo: https://domain.com). Endereços IP não podem ser usados como endpoints de webhooks.

5. Opcionalmente, insira um segredo para autenticação do webhook.

   • O segredo deve ter entre 32 e 64 caracteres.

   • Se for criado, o segredo será incluído como parte de um hash, anexado à solicitação HTTP como qlik-signature.

6. Opcionalmente, adicione cabeçalhos HTTP para anexar à solicitação.

7. Em Eventos, escolha os eventos do sistema que acionarão o webhook. Os eventos disponíveis incluem:

   • Eventos do aplicativo: criados, excluídos, exportados, dados atualizados (renovados), publicados, recarregados.

   • Eventos do usuário: criados, excluídos.

8. Clique em Criar.

Gerenciando webhooks

Classificando e pesquisando webhooks

Para classificar e pesquisar webhooks na tabela:

• Clique em na parte superior de uma coluna para alterar a ordem de classificação.

• Clique em na parte superior de uma coluna para pesquisar por um webhook. O filtro de pesquisa funciona para correspondências completas e parciais.

Ativando ou desativando webhooks

Faça o seguinte:

1. No centro de atividades de Administração, acesse Webhooks.

2. Clique em ao lado do webhook.

3. Para ativar o webhook, selecione Ativar webhook.

4. Para desativar o webhook, selecione Desativar webhook.

Webhooks recém-criados são ativados por padrão.

Editando webhooks

Faça o seguinte:

1. No centro de atividades de Administração, acesse Webhooks.

2. Para o webhook que você deseja editar, clique em .

3. Selecione Editar.

4. Faça suas edições e clique em Salvar.

Excluindo webhooks

Faça o seguinte:

1. No centro de atividades de Administração, acesse Webhooks.

2. Selecione o webhook a ser excluído.

3. Clique em Excluir.

4. Confirme a exclusão.

Visualizando histórico do webhook

O histórico de eventos do webhook é mantido por 7 dias.

Faça o seguinte:

1. No centro de atividades de Administração, acesse Webhooks.

2. Clique em ao lado de um webhook para expandir seu histórico de eventos.

   

3. Para reenviar manualmente uma distribuição de evento, clique em na linha do evento.

4. Para visualizar a carga útil da resposta do evento, clique em na linha do evento.

   A carga útil mostra detalhes como ID do aplicativo, nome e registro de data e hora, o que é útil para depuração ou auditoria de eventos passados.