Criando webhooks para fluxos de trabalho
Os webhooks fornecem uma maneira de você usar eventos do sistema do Qlik Cloud como gatilhos em seu fluxo de trabalho. Depois de criar um webhook, ele envia automaticamente uma solicitação JSON ao endpoint do webhook sempre que esse evento definido do sistema ocorre. Você pode usar webhooks para enviar dados de eventos a qualquer aplicativo que possa receber dados JSON.
Se o locatário estiver usando a nova experiência de navegação, o centro de atividades de Administração substituirá o Console de gerenciamento.
Para obter mais informações, consulte Nova navegação na plataforma.
Propriedades de webhooks
Para criar um webhook, você deve configurar as propriedades do webhook e do ponto de extremidade e escolher os tipos de eventos do Qlik Cloud.
Propriedade | Descrição |
---|---|
Nome | Nome do webhook. |
Descrição (opcional) | Descrição do webhook. |
URL | URL do ponto de extremidade de webhook. A URL (ponto de extremidade de webhook) deve ser um nome de domínio totalmente qualificado (FDQN) e deve usar o protocolo HTTPS. O endpoint não pode ser um endereço IP. |
Segredo (opcional) | Segredo para autenticação do webhook. O segredo deve ter no mínimo 32 caracteres e no máximo 64 caracteres. Se você criar um segredo de webhook, ele fará parte de um hash anexado à solicitação HTTP como um qlik-signature. |
Headers (opcionais) |
Headers que podem ser anexados à solicitação HTTP. |
Cada webhook é configurado com um ou mais tipos de eventos.
Recurso | Tipos de evento |
---|---|
Aplicativos | Criados, excluídos, dados atualizados, carregados, publicados, exportados Nota informativaUm evento de atualização de dados refere-se a dados que estão sendo atualizados. Um evento de carregamento refere-se ao Qlik Sense Qlik Cloud e tabelas de dados associadas que estão sendo carregados. |
Usuários | Criados, excluídos |
O webhook aguarda a ocorrência de um dos eventos para enviar os dados do evento ao ponto de extremidade de webhook. Os dados são transmitidos à URL do ponto de extremidade como uma solicitação JSON.
Exemplo: Solicitação JSON para tipo de evento de aplicativo excluído
Request
URL
https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx
Headers
{
"Content-Type": "application/json",
"Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",
"User-Agent": "Qlik Webhook"
}
Body
{
"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 um webhook
Crie webhooks no Console de gerenciamento. Você também pode criar webhooks a partir da interface do Qlik Application Automation. Para obter mais informações, consulte Trabalhando com webhooks (somente em inglês).
É possível criar no máximo 100 webhooks para cada locatário.
Faça o seguinte:
-
No Console de gerenciamento, acesse Webhooks.
-
No canto superior direito, clique em Criar novo.
-
Na caixa de diálogo Criar webhook, insira um nome para o webhook.
-
Adicione uma descrição opcional.
-
Insira a URL do aplicativo de integração de terceiros.
-
Opcionalmente, insira o segredo para anexar à solicitação HTTP.
-
Opcionalmente, adicione headers HTTP para anexar à solicitação.
-
Em Eventos, selecione o tipo de evento para o webhook.
-
Quando terminar, clique em Criar.
Os webhooks são listados em uma tabela. Webhooks recém-criados são ativados por padrão.
Editando um webhook
Faça o seguinte:
-
No Console de gerenciamento, acesse Webhooks.
-
Para o webhook que você deseja editar, clique no botão no final da linha.
-
Clique em Editar.
O painel de edição é exibido com opções para alterar a configuração do webhook.
-
Faça suas edições e clique em Salvar.
Excluindo um webhook
Faça o seguinte:
-
No Console de gerenciamento, acesse Webhooks.
-
Selecione o webhook a ser excluído.
-
No canto superior direito, clique em Excluir.
-
É aberto um diálogo pop-up para confirmar sua escolha. Clique em Excluir.
Visualizando o histórico do webhook
Acesse o histórico do webhook em Webhooks no Console de gerenciamento.
-
Para visualizar o histórico do webhook, clique no botão no final da linha do webhook.
O histórico do webhook é exibido.
-
Para reenviar manualmente uma distribuição de evento, clique no botão no final da linha do evento.
-
Para visualizar a carga útil da resposta do evento, clique no botão no final da linha do evento.