Webhooks no App Builder do Jitterbit
Visão geral
Um webhook é uma notificação automatizada enviada entre aplicativos quando um evento específico ocorre. O App Builder usa webhooks para disparar ações específicas em resposta a emails, mensagens de texto ou chamadas de API.
Por exemplo, um aplicativo pode enviar um email a um usuário para aprovar ou rejeitar uma transferência. Se o usuário responder "aprovar", um webhook dispara o processo de aprovação; se responder "rejeitar", dispara uma rejeição. Isso permite que os usuários concluam tarefas diretamente da caixa de entrada ou do aplicativo de mensagens sem precisar fazer login novamente no aplicativo principal.
Esta página ensina as etapas para criar e configurar um webhook:
- Etapa 1: Adicionar um servidor de dados webhook
- Etapa 2: Adicionar o webhook ao seu aplicativo
- Etapa 3: Criar uma regra de negócio webhook
- Etapa 4: Criar uma regra de negócio XP CRUD
- Etapa 5: Expor o webhook
- Etapa 6: Criar uma chave de API para um usuário
- Etapa 7: Testar o webhook
Esta página também contém uma seção de Solução de problemas abordando um erro comum de webhook e como resolvê-lo.
Criar um webhook
Siga estas etapas para configurar e expor um webhook de ponta a ponta:
Etapa 1: Adicionar um servidor de dados webhook
Um webhook precisa de seu próprio servidor de dados, do tipo Webhook API, para receber chamadas HTTP de entrada. Siga estas etapas para criar um:
-
Navegue até IDE.
-
Selecione IDE > Data Servers.
-
Clique em + Server. A caixa de diálogo Server é aberta:

-
Defina valores para o seguinte:
-
Server Name: Digite um nome.
-
Type: Selecione Webhook API. Isso faz com que mais opções sejam exibidas.
-
Request Content Type: Selecione JSON.
-
Response Content Type: Selecione JSON.
-
-
Clique em Save.
-
Saia da caixa de diálogo.
-
Com o servidor criado, defina o ponto de extremidade específico que o webhook chamará:
-
Na lista de servidores, localize o servidor que você acabou de criar e selecione-o. Ao fazer isso, o novo servidor é listado no outro painel da tela.
-
Clique no ícone Open record:
-
A caixa de diálogo Webhook API é aberta. Na seção REST API, clique em Endpoints:
-
A página Web Service é aberta. No painel Endpoints, clique em + Endpoint:
Defina valores para os seguintes parâmetros:
-
Name: Escolha um nome para seu ponto de extremidade.
-
Endpoint: Você pode deixar este campo em branco.
-
Method: Selecione POST.
-
-
Clique no ícone de marca de seleção para salvar.
Por fim, descubra os parâmetros que o corpo da solicitação do webhook fornecerá:
-
No painel Endpoints, clique em Discover. A caixa de diálogo Endpoint é aberta:

-
Defina valores para o seguinte:
-
Name: Este campo é preenchido automaticamente com o nome que você escolheu para o ponto de extremidade.
-
End Point: Você pode deixar este campo em branco.
-
Method: Selecione POST.
-
Request Body: Se o webhook aceita um corpo (por exemplo, um POST usando JSON ou tipo de conteúdo da solicitação XML), forneça um corpo de solicitação de exemplo. Por exemplo:
{ "Company": "Jitterbit", "Product": "App Builder" }
-
-
Clique em Discover. O App Builder adiciona automaticamente os parâmetros do ponto de extremidade.
-
Etapa 2: Adicionar o webhook ao seu aplicativo
Com o servidor e o ponto de extremidade do webhook definidos, vincule esse servidor ao seu aplicativo como uma fonte de dados:
-
Acesse App Workbench > Data Sources.
-
Clique em + Source. Um diálogo se abre.
-
Selecione Link to existing source.
-
Clique em Next.
-
Localize e selecione a Webhook API REST que você configurou em Step 1 na lista.
-
Clique no botão Link.
-
Clique em Done.
Etapa 3: Criar uma regra de negócio webhook
Em seguida, crie uma regra de negócio que mapeie os dados recebidos pelo webhook para uma fonte de dados utilizável:
-
Acesse App Workbench > Data Sources.
-
No painel App Data Sources, selecione a fonte de dados do webhook que você acabou de criar:
-
No painel Rules, clique em + Rule. O Rule Builder se abre.
-
Configure sua nova regra da seguinte forma:
-
Clique em Create. O App Builder cria a regra e exibe sua tela de edição.
-
No painel Tables, clique em + Tables. Um diálogo se abre.
-
Selecione o endpoint do webhook clicando no seu botão Add. Ele aparece no painel Tables.
-
No painel Tables, selecione todas as colunas do endpoint.
Etapa 4: Criar uma regra de negócio XP CRUD
A regra do webhook por si só apenas define a forma dos dados recebidos. Anexe uma regra XP CRUD ao seu evento Insert para que os dados fiquem disponíveis para outras regras e tabelas em seu aplicativo:
-
Na tela de edição da regra de negócio que você criou em Etapa 3, clique em Events no painel Rule. O diálogo All Events se abre.
-
Clique duas vezes na linha com o evento Insert. A janela Insert se abre:
-
No painel Event Information, selecione Row Refresh no menu Refresh Scope.
-
No painel Actions, clique em + Rule & Register. Uma nova instância do Rule Builder se abre. Configure-a da seguinte forma:
-
Name: Dê um nome descritivo, por exemplo,
WebhookCreation_XP_CRUD. -
Purpose: Selecione XP CRUD.
-
Action: Selecione Insert.
-
Target Layer: Selecione Logic Layer.
-
Target: Selecione a regra de negócio que você criou em Etapa 3.
-
-
Clique em Create. A nova regra de negócio é criada e sua tela de edição aparece.
-
No painel Tables, clique em + Tables.
-
Selecione o endpoint que você criou em Step 1 clicando no seu botão Add. Ele será exibido no painel Tables.
-
Selecione todas as suas colunas.
-
Clique em Validate.
Etapa 5: Expor o webhook
Por fim, exponha a regra do webhook através da REST API do App Builder para que sistemas externos possam chamá-la via HTTP:
-
Selecione IDE > REST APIs.
-
Acesse a aba Webhooks.
-
No painel Services, clique no botão Manage Endpoints para abrir o diálogo Applications:

-
Localize seu aplicativo e clique no seu ícone de lápis.
-
Digite um nome para seu endpoint e clique em Proceed.
-
(Desde o App Builder 4.67.) Clique no ícone Authentication do aplicativo. O diálogo Authentication Providers se abre. Adicione os provedores de chave API, HTTP ou Authorization Server que você deseja permitir para autenticar as solicitações do Webhook deste aplicativo. Consulte Configurar um endpoint para as etapas exatas.
Nota
Esta opção não está disponível em um aplicativo sealed. Para um aplicativo selado, clique no ícone em sua coluna Web Service em Applications, que abre este mesmo diálogo Authentication Providers de fora do aplicativo.
-
Feche o diálogo. No painel Services, clique no ícone de chevron no tile da sua aplicação. A página Webhook API abre, exibindo os painéis Service e Webhooks.
-
(A partir do App Builder 4.67.) No painel Service, clique em More > Configure Authentication:
O mesmo diálogo Authentication Providers da etapa 6 abre. Adicione e salve provedores da mesma forma descrita lá.
-
No painel Webhooks, clique em + Webhook. O diálogo Webhook abre:

Configure-o da seguinte forma:
-
Webhook: Selecione a regra de webhook que você criou. Após salvar o diálogo, o ícone ao lado desse campo fica clicável, levando você para a página Rule Builder da regra no App Workbench.
-
Endpoint: Insira o segmento de caminho onde o webhook é acessado.
-
Compatibility: Deixe a opção padrão. Consulte Compatibility para as opções disponíveis, que também se aplicam aqui.
-
-
Clique em Save.
-
(Opcional.) Clique no ícone de detalhes do webhook para ver o diálogo Webhook, onde é possível configurar plugins de request/response que transformam o payload conforme ele passa pelo webhook.
Etapa 6: Criar uma chave de API para um usuário
Por fim, gere uma chave de API para que um usuário específico possa autenticar chamadas para este webhook:
-
Selecione IDE > User Management.
-
No painel Users, selecione um usuário que tenha privilégios de administrador e clique duas vezes na sua linha. O diálogo User abre:

-
Clique em More > Keys. O diálogo Keys abre.
-
Clique em Create. O diálogo Generate Key abre.
-
Configure a nova chave da seguinte forma:
-
Provider: Selecione seu provedor de segurança API Key (consulte Configurar um provedor de segurança de chave de API se ainda não configurou um).
-
Description: (Opcional) Forneça uma breve descrição.
-
Expires In: (Opcional) Insira um tempo de expiração personalizado.
-
-
Clique em Save para criar a chave de API.
Importante
Anote as informações, pois não é possível exibi-las novamente.

Etapa 7: Testar o webhook
Teste seu novo webhook (usando, por exemplo, Postman, Insomnia ou ferramentas similares). Envie uma chamada de API POST com um corpo semelhante ao exemplo de corpo usado para criar os parâmetros na Etapa 1. Use autenticação básica com o identificador e a chave da Etapa 6 como nome de usuário e senha.
Para testes, use o link: https://<url>/webhook/v1/<application-endpoint>/<endpoint>.
Quando nenhuma autenticação é necessária, em vez de configurar uma x-api-key no header, é possível ajustar a URL para uma das seguintes opções:
-
https://{{user's identifier from Step 6}}:{{user's key from Step 6}}@{{url from Step 7}}(a ser usada se o provedor for HTTP basic auth sem parâmetros)Cuidado
O método HTTP basic descrito acima exige que o header Authorization seja incluído no payload recebido. Para contornar isso, use o método API Key.
-
https://{{url from step7}}?apiKey={{user's key from Step 6}}(a ser usada se o provedor for API Key e as Properties incluirem HttpHeaderName 'X-API-Key')
Solução de problemas
Para uma causa comum de falhas de autenticação de webhook, consulte Webhook: Autenticação HTTP Básica requer o cabeçalho Authorization no payload no guia de solução de problemas do App Builder.





