Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Webhook
Com o conector de webhook, é possível detectar eventos do seu back-end que aceita webhooks. Ele foi projetado para ser usado com o gatilho de webhook. O gatilho de webhook recebe eventos de aplicativos SaaS de terceiros que oferecem suporte à capacidade de eventos de webhook. Esse gatilho é compatível com vários tipos de autenticação para seu listener de eventos. Para usar o gatilho de webhook na sua integração, primeiro configure um conector de webhook.
Antes de começar
Antes de usar o conector de webhook, faça o seguinte:
Conceda os seguintes papéis do IAM à conta de serviço que você quer usar para o conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário
não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google.
Se você não tiver uma conta de serviço, será necessário criar uma. Para mais
informações, consulte
Como criar uma conta de serviço.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los
ao configurar o conector.
Configurar o conector
Uma conexão é específica a uma fonte de dados. Isso
significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada
para cada uma. Para criar uma conexão, faça o seguinte:
No console do Cloud, acesse a página Integration Connectors > Conexões
e selecione ou crie um projeto do Google Cloud.
Local do campo de tipo de evento: campo obrigatório que indica o local (cabeçalho, parâmetro de consulta ou corpo da solicitação) em que o tipo de evento associado à solicitação de evento recebida vai estar presente.
Nome do campo de tipo de evento: campo obrigatório no local configurado que identifica
o tipo de evento associado à solicitação de evento recebida.
{"event_type":"user.created",...// other request fields...}
No exemplo acima, o campo event_type no corpo da solicitação significa que a solicitação se refere a um evento "user.created".
Selecione Ativar conectividade particular para uma conectividade segura entre o aplicativo de back-end
e a conexão. Se você selecionar essa opção, precisará executar mais etapas de configuração
depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinatura de eventos.
Insira a configuração de mensagens inativas. Se você configurar a carta inativa, a conexão gravará
os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
ID do projeto de dead-letter : o ID do projeto do Google Cloud em que você configurou o tópico de dead-letter do Pub/Sub.
Tópico de mensagens mortas : o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
Clique em Próxima.
Revisão: revise os detalhes de conexão e autenticação do listener.
Clique em Criar.
Usar a conexão de webhook em uma integração
Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão
em uma integração pela tarefa de conectores.
Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte Tarefa "Conectores".
Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".
Receber ajuda da comunidade do Google Cloud
Poste suas dúvidas e converse sobre esse conector na comunidade do Google
Cloud em Fóruns do Cloud.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-22 UTC."],[[["\u003cp\u003eThe Webhook connector allows you to listen to events from backends that support webhooks, and it is specifically designed for use with the Webhook trigger, enabling the reception of events from third-party SaaS applications.\u003c/p\u003e\n"],["\u003cp\u003eBefore configuring the Webhook connector, you must enable the \u003ccode\u003esecretmanager.googleapis.com\u003c/code\u003e and \u003ccode\u003econnectors.googleapis.com\u003c/code\u003e services in your Google Cloud project, and grant the required IAM roles to the designated service account.\u003c/p\u003e\n"],["\u003cp\u003eConfiguring a Webhook connection involves specifying the connection details, including selecting the Webhook connector, naming the connection, choosing a service account, and specifying the event subscription details, which is mandatory for the webhook connector.\u003c/p\u003e\n"],["\u003cp\u003eThe Webhook connector supports various listener authentication types, including No Authentication, Google Authentication, API Key Authentication, and Basic Authentication, with specific details required for each type.\u003c/p\u003e\n"],["\u003cp\u003eUpon creation, the Webhook connection can be used within Apigee Integration and Application Integration through the Connectors task, and resources are available to monitor usage, view logs, and suspend/resume the connection.\u003c/p\u003e\n"]]],[],null,["# Webhook\n\n| **Preview**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nWebhook\n=======\n\nThe Webhook connector lets you listen to events from your backend that supports webhooks. This connector is designed to be used with the [Webhook trigger](/application-integration/docs/configure-webhook-trigger). The Webhook trigger receives events from third-party SaaS-based applications that support webhook eventing capability. This trigger supports multiple authentication types for your event listener. To use the Webhook trigger in your integration, you must first configure a Webhook connector.\n\nBefore you begin\n----------------\n\nBefore using the Webhook connector, do the following tasks:\n\n- In your Google Cloud project:\n - Enable the following services:\n - `secretmanager.googleapis.com` (Secret Manager API)\n - `connectors.googleapis.com` (Connectors API)\n\n To understand how to enable services, see [Enabling services](/service-usage/docs/enable-disable#enabling).\n - Grant the following IAM roles to the service account that you want to use for the connector:\n - `roles/secretmanager.viewer`\n - `roles/secretmanager.secretAccessor`\n\n A service account is a special type of Google account intended to represent a non-human\n user that needs to authenticate and be authorized to access data in Google APIs.\n If you don't have a service account, you must create a service account. The connector and the service account must belong to the same project. For more\n information, see\n [Creating a service account](/iam/docs/creating-managing-service-accounts#creating).\n\n\n If these services or permissions have not been enabled for your project previously, you are prompted to enable them\n when configuring the connector.\n\nConfigure the connector\n-----------------------\n\nA connection is specific to a data source. It\nmeans that if you have many data sources, you must create a separate connection\nfor each data source. To create a connection, do the following:\n\n1. In the [Cloud console](https://console.cloud.google.com), go to the **Integration Connectors \\\u003e Connections** page and then select or create a Google Cloud project.\n\n\n [Go to the Connections page](https://console.cloud.google.com/connectors/connections)\n2. Click **+ Create new** to open the **Create Connection** page.\n3. In the **Location** section, choose the location for the connection.\n 1. **Region** : Select a location from the drop-down list.\n\n For the list of all the supported regions, see [Locations](/integration-connectors/docs/locations).\n 2. Click **Next**.\n4. In the **Connection Details** section, complete the following:\n 1. **Connector** : Select **Webhook** from the drop down list of available Connectors.\n 2. **Connector version**: Select the Connector version from the drop down list of available versions.\n 3. **Connection Name** : Enter a name for the Connection instance.\n\n Connection names must meet the following criteria:\n - Connection names can use letters, numbers, or hyphens.\n - Letters must be lower-case.\n - Connection names must begin with a letter and end with a letter or number.\n - Connection names cannot exceed 49 characters.\n - For connectors that [support event subscription](/integration-connectors/docs/eventsubscription#enable-event-subscriptions-in-connections), the connection names cannot begin with the \"goog\" prefix.\n 4. **Description**: Optionally, enter a description for the connection instance.\n 5. **Service Account** : Select a service account that has the [required roles](#before-you-begin).\n 6. **Event Subscription** : Event subscription will be enabled by default and is mandatory for webhook connector. **Note:** The `Enable event subscription, entity and actions` option isn't supported for this connection.\n 7. Optionally, click **+ Add label** to add a label to the Connection in the form of a key/value pair.\n 8. Click **Next**.\n5. In the **Event Subscription Details** section, complete the following:\n 1. **Listener Authentication** : Select an authentication type for event listener and enter the relevant details.\n\n The following authentication types are supported by the webhook listener:\n - No Authentication\n - [Google Authentication](/iam/docs/workload-identities): Ensure that the service account has [roles/connectors.listener](https://cloud.google.com/iam/docs/understanding-roles#cloud-connectors-roles) role whose access token is used for authentication.\n - API Key Authentication\n - [Basic Authentication](https://www.rfc-editor.org/rfc/rfc7617)\n 2. **Event Type Field Location**: Mandatory field which denotes the location (Header, Query Param or Request Body) where event type associated with the incoming event request will be present.\n 3. **Event Type Field Name**: Mandatory field in the configured location identifies the type of event associated with the incoming event request. \n\n ```json\n {\n \"event_type\": \"user.created\",\n ...\n // other request fields\n ...\n }\n ```\n In the example above, the **event_type** field in **request body** signifies that the request pertains to a \"user.created\" event.\n 4. Select **Enable private connectivity** for secured connectivity between your backend application and your connection. If you select this option, you must perform additional configuration steps after creating the connection. For more information, see [Private connectivity for event subscription](/integration-connectors/docs/eventsubscription#psc-eventing).\n 5. Enter the dead-letter configuration. If you configure dead-letter, the connection writes the unprocessed events to the specified [Pub/Sub topic](/pubsub/docs/pubsub-basics). Enter the following details:\n 1. **Dead-letter project ID:**The Google Cloud project ID where you have configured the dead-letter Pub/Sub topic.\n 2. **Dead-letter topic:**The Pub/Sub topic where you want to write the details of the unprocessed event.\n 6. Click **Next**.\n6. **Review**: Review your connection and listener authentication details.\n7. Click **Create**.\n\nUse the Webhook connection in an integration\n--------------------------------------------\n\nAfter you create the connection, it becomes available in both\nApigee Integration and Application Integration. You can use the connection\nin an integration through the Connectors task.\n\n- To understand how to create and use the Connectors task in Apigee Integration, see [Connectors task](/apigee/docs/api-platform/integration/connectors-task#configure-the-connectors-task).\n- To understand how to create and use the Connectors task in Application Integration, see [Connectors task](/application-integration/docs/connectors-task).\n\nGet help from the Google Cloud community\n----------------------------------------\n\nYou can post your questions and discuss this connector in the Google Cloud community at [Cloud Forums](https://www.googlecloudcommunity.com/gc/Integration-Services/bd-p/cloud-integration-services).\n\nWhat's next\n-----------\n\n- Understand how to [suspend and resume a connection](/integration-connectors/docs/suspend-resume-connection).\n- Understand how to [monitor connector usage](/integration-connectors/docs/cloud-monitoring).\n- Understand how to [view connector logs](/integration-connectors/docs/view-connector-logs)."]]
