RWS Docs

Este guia mostra como criar uma integração que é acionada quando um webhook é chamado, transforma os dados recebidos e os envia para um endpoint de destino. Ao final, você entenderá como configurar integrações acionadas por webhook e testá-las usando cURL.

O que você vai construir

Você criará uma integração que:

Extrai dados de requisições webhook recebidas
Transforma os dados mapeando campos para o formato de destino
Envia os resultados transformados para webhook.site onde você pode inspecioná-los

Tempo necessário: aproximadamente 5 minutos.

Pré-requisitos

Acesso a um Workspace da RWS Integration
Um navegador web
cURL (ou ferramenta de linha de comando similar) para acionar o webhook

Certifique-se de estar no Workspace correto usando o seletor de workspace na barra lateral antes de começar.

Passo 1: Configure seu destino

Antes de criar a integração, crie um endpoint de destino onde você pode verificar os resultados.

Abra webhook.site em uma nova aba do navegador
O site gera automaticamente uma URL única (ex.: https://webhook.site/abc123-def456-...)
Copie a parte do caminho único (ex.: /abc123-def456-...), pois você precisará dela ao configurar a fase de Envio
Mantenha esta aba aberta para monitorar requisições recebidas

webhook.site é um serviço gratuito que captura e exibe requisições HTTP. É útil para testar integrações antes de conectar a sistemas de destino reais.

Passo 2: Crie a conexão de webhook

Conexões definem como a RWS Integration se comunica com sistemas externos. Você criará uma para a fonte webhook.

Na barra lateral, clique em Conexões
Clique em Nova Conexão
Configure a conexão:

Campo	Valor
Nome	`[Doc] Webhook Extract Connection`
Versão	`1.0.0`
Tipo	`Webhook`

Clique em Salvar
Copie o ID da conexão: você pode encontrá-lo na URL após criar a conexão. Você precisará deste ID ao acionar o webhook com cURL.

Passo 3: Crie a conexão de destino

Agora crie uma Conexão para seu destino webhook.site.

Clique em Nova Conexão
Configure a conexão:

Campo	Valor
Nome	`[Doc] Webhook Site Load Connection`
Versão	`1.0.0`
Tipo	`API`
URL	`https://webhook.site`
Caminho base (URL base path)	`/`
Autenticação	`Sem autenticação`

Clique em Salvar

Passo 4: Crie a Integração

Com ambas as Conexões prontas, crie a Integração que processa requisições webhook e as entrega ao seu destino.

Na barra lateral, clique em Integrações
Clique em Nova Integração

Configurações gerais

Configure as propriedades básicas da integração:

Campo	Valor
Nome	`[Doc] Webhook Integration`
Versão	`1.0.0`
Tipo	`Full`
Ambiente	`Staging`
Agendamento	Diária, em qualquer horário

Estamos usando o ambiente Staging para testes. Quando estiver pronto para implementar em produção, você pode alterar isso para Production. A RWS Integration mantém esses ambientes separados para que você possa testar alterações com segurança antes de colocar em produção.

Para integrações acionadas por webhook, o Agendamento é obrigatório mas não é usado ativamente: webhooks acionam a integração sob demanda quando requisições são recebidas, então qualquer frequência funciona aqui.

Fase de Extração

A fase de Extração recebe dados de requisições webhook recebidas.

Expanda a seção Extração
Configure estes campos:

Campo	Valor
Conexão	`[Doc] Webhook Extract Connection`

Ao usar uma conexão webhook, a RWS Integration recebe automaticamente o corpo da requisição de chamadas webhook recebidas. Você não precisa configurar um método ou caminho.

O webhook aceitará requisições POST recebidas com payloads JSON. Você pode adicionar um corpo de exemplo ao painel Preview de Extração para disponibilizá-lo para o preview da transformação e envio:

{
  "id": "1234567890",
  "description": "Item description"
}

Fase de Transformação

A fase de Transformação mapeia campos de origem da requisição webhook para o formato de destino. Para este guia, crie um mapeamento simples com dois campos.

Expanda a seção Transformação
Clique em Adicionar Transformação e configure:

Tipo	Para	De
Simples	`externalId`	`id`
Simples	`itemDescription`	`description`

Verifique o painel Preview de Transformação. Ele deve exibir a estrutura transformada com base em dados de exemplo:

{
  "externalId": "1234567890",
  "itemDescription": "Item description"
}

Isso confirma que seus mapeamentos estão funcionando corretamente e mostra como os dados do webhook serão transformados.

O Preview de Transformação usa dados de exemplo para demonstrar a transformação. Quando você acionar o webhook com dados reais, eles serão transformados de acordo com esses mapeamentos.

Fase de Envio

A fase de Envio envia dados transformados para seu destino.

Expanda a seção Envio
Configure estes campos:

Campo	Valor
Conexão	`[Doc] Webhook Site Load Connection`
Método	`POST`
Caminho (URL path)	Seu caminho único do webhook.site (ex.: `/abc123-def456-...`)
Tipo de Envio	`Simples`

Copie apenas a parte do caminho da sua URL do webhook.site. Se sua URL completa for https://webhook.site/abc-123, insira /abc-123 como o Path.

Verifique o painel Preview de Envio. Ele mostra a requisição completa que será enviada:
- Path: URL completa de destino
- Method: POST
- Request Body: Sua estrutura de dados transformada

O Preview de Envio não envia dados ao destino: ele apenas mostra o que será enviado quando você executar a integração. Isso permite validar sua configuração com segurança antes de executar.

Passo 5: Crie a Integração

Ative o toggle Implantação
Clique em Criar Integração

A integração agora está ativa e pronta para receber requisições webhook. Diferente de integrações agendadas, integrações webhook aguardam requisições recebidas em vez de executar em um agendamento.

Passo 6: Acione e verifique a integração

Agora teste sua integração enviando uma requisição webhook usando cURL. Substitua os seguintes placeholders no comando cURL:

{{ tenantId }} - O ID do tenant da sua organização (você pode encontrá-lo na URL do workspace da RWS Integration)
{{ webhookId }} - O ID da conexão webhook do Passo 2 (você pode encontrá-lo na URL da página da conexão webhook)
{{ apiKey }} - Sua chave de API da RWS Integration (entre em contato com a equipe da RWS Integration se necessário)

Execute o seguinte comando cURL:

curl -X POST "https://api.rwsintegration.com/v1/webhook?tenantId={{ tenantId }}&webhookId={{ webhookId }}" \
  -H "x-api-key: {{ apiKey }}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "1234567890",
    "description": "Item description"
  }'

Você deve receber uma resposta similar a:

{
  "success": true,
  "message": "1 jobs queued for 1 integrations",
  "jobIds": [
    "1234567890"
  ],
  "integrationCount": 1
}

Em alguns segundos, mude para a aba do webhook.site no seu navegador. Você deve ver uma requisição POST recebida contendo sua estrutura de dados transformada:

{
  "externalId": "1234567890",
  "itemDescription": "Item description"
}

Isso confirma que sua integração webhook recebeu com sucesso a requisição, transformou os dados e os entregou ao destino.

Você também pode testar sem cURL: abra a integração e clique em Executar agora, ao lado do botão Salvar. Para integrações webhook, o diálogo pede o payload JSON que o webhook receberia. Ele vem preenchido com o corpo de exemplo do preview (se você tiver informado um) ou com o último payload usado.

Parabéns! Você criou e testou sua primeira integração acionada por webhook!

Entrega assíncrona

Por padrão, o webhook responde depois de terminar de processar a requisição. Se o provedor que faz a chamada impõe um tempo limite curto, ele pode desistir antes de a resposta chegar e reenviar o mesmo evento, causando duplicatas. Adicione async=true à URL do webhook para que ele responda imediatamente e processe a requisição em segundo plano.

curl -X POST "https://api.rwsintegration.com/v1/webhook?tenantId={{ tenantId }}&webhookId={{ webhookId }}&async=true" \
  -H "x-api-key: {{ apiKey }}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "1234567890",
    "description": "Item description"
  }'

A resposta confirma que a requisição foi aceita:

{
  "success": true,
  "message": "Webhook accepted for asynchronous processing"
}

Confira os resultados no Monitoramento.

O que você aprendeu

Integrações seguem o padrão Extração → Transformação → Envio (com Enriquecimento opcional)
Conexões webhook recebem requisições recebidas em vez de fazer chamadas de API de saída
Painéis de Preview atualizam automaticamente conforme você configura cada fase, permitindo validar antes de executar
Transformações simples mapeiam campos da origem para o destino usando notação JSONPath
Como acionar a integração webhook com uma requisição POST usando cURL
Modos de entrega: síncrono por padrão, ou assíncrono com async=true para provedores com timeouts curtos

Próximos passos

Conexões

Aprenda sobre os diferentes métodos de autenticação

Mapeamento de Dados

Transforme dados entre formatos de origem e destino

Regras de Negócio

Domine transformações de campos com JavaScript

Monitoramento e Depuração

Observe e solucione problemas de execuções de integração

Primeiros Passos

Guias

Conceitos Fundamentais

Integração acionada por Webhook

O que você vai construir

Pré-requisitos

Passo 1: Configure seu destino

Passo 2: Crie a conexão de webhook

Passo 3: Crie a conexão de destino

Passo 4: Crie a Integração

Configurações gerais

Fase de Extração

Fase de Transformação

Fase de Envio

Passo 5: Crie a Integração

Passo 6: Acione e verifique a integração

Entrega assíncrona

O que você aprendeu

Próximos passos

Conexões

Mapeamento de Dados

Regras de Negócio

Monitoramento e Depuração

​O que você vai construir

​Pré-requisitos

​Passo 1: Configure seu destino

​Passo 2: Crie a conexão de webhook

​Passo 3: Crie a conexão de destino

​Passo 4: Crie a Integração

​Configurações gerais

​Fase de Extração

​Fase de Transformação

​Fase de Envio

​Passo 5: Crie a Integração

​Passo 6: Acione e verifique a integração

​Entrega assíncrona

​O que você aprendeu

​Próximos passos

Conexões

Mapeamento de Dados

Regras de Negócio

Monitoramento e Depuração

O que você vai construir

Pré-requisitos

Passo 1: Configure seu destino

Passo 2: Crie a conexão de webhook

Passo 3: Crie a conexão de destino

Passo 4: Crie a Integração

Configurações gerais

Fase de Extração

Fase de Transformação

Fase de Envio

Passo 5: Crie a Integração

Passo 6: Acione e verifique a integração

Entrega assíncrona

O que você aprendeu

Próximos passos