Consulta i connettori supportati per Application Integration.
Attivatore webhook
L'attivatore webhook è un attivatore di eventi connettore che ti consente di richiamare un'integrazione in base a qualsiasi evento del backend che supporta i webhook. Il trigger webhook riceve eventi da applicazioni basate su SaaS di terze parti che supportano la funzionalità di eventi webhook. Questo trigger supporta più tipi di autenticazione per il listener di eventi.
Prima di iniziare
Se prevedi di creare o configurare una nuova connessione per il trigger webhook, assicurati di disporre del seguente ruolo Identity and Access Management (IAM) nel progetto:
- Connector Admin (
roles/connectors.admin
)
Per informazioni sulla concessione dei ruoli, vedi Gestire l'accesso.
Concedi i seguenti ruoli IAM al account di servizio che vuoi utilizzare per il trigger webhook:
- Application Integration Invoker (
roles/integrations.integrationInvoker
)
Per informazioni sulla concessione dei ruoli a un account di servizio, vedi Gestire l'accesso ai service account.
Aggiungere l'attivatore webhook
Per aggiungere un trigger webhook all'integrazione, segui questi passaggi:
- Nella console Google Cloud , vai alla pagina Integrazione di applicazioni.
- Nel menu di navigazione, fai clic su Integrazioni.
Viene visualizzata la pagina Elenco integrazioni, che elenca tutte le integrazioni disponibili nel progetto Google Cloud.
- Seleziona un'integrazione esistente o fai clic su Crea integrazione per crearne una nuova.
Se stai creando una nuova integrazione:
- Inserisci un nome e una descrizione nel riquadro Crea integrazione.
- Seleziona una regione per l'integrazione.
- Seleziona un account di servizio per l'integrazione. Puoi modificare o aggiornare i dettagli dell'account di servizio di un'integrazione in qualsiasi momento dal riquadro Riepilogo integrazione nella barra degli strumenti dell'integrazione.
- Fai clic su Crea.
L'integrazione appena creata si apre nell'editor integrazioni.
- Nella barra di navigazione dell'editor dell'integrazione, fai clic su Attivatori per visualizzare l'elenco degli attivatori disponibili.
- Fai clic sull'elemento Webhook trigger e posizionalo nell'Editor integrazioni.
Per configurare il trigger webhook, puoi utilizzare una connessione webhook esistente disponibile in Integration Connectors o crearne una nuova utilizzando l'opzione di creazione della connessione inline.
Configurare il trigger webhook utilizzando una connessione esistente
Puoi configurare il trigger webhook utilizzando una connessione webhook esistente in Integration Connectors. Tieni presente che l'attivatore webhook è un attivatore evento connettore, pertanto puoi utilizzare solo una connessione webhook con l'iscrizione agli eventi abilitata per configurare l'attivatore.
Per informazioni su come configurare un trigger webhook utilizzando una nuova connessione webhook, consulta Configurare il trigger webhook utilizzando una nuova connessione.
Per configurare un trigger webhook utilizzando una connessione webhook esistente, segui questi passaggi:
- Fai clic sull'elemento Webhook trigger nell'Editor integrazioni per aprire il riquadro di configurazione del trigger.
- Fai clic su Configura trigger.
- Fornisci i seguenti dettagli di configurazione nella pagina Editor attivatore eventi connettore:
- Regione:seleziona la regione della connessione webhook.
- Connessione:seleziona la connessione webhook che vuoi utilizzare.
L'Application Integration mostra solo le connessioni webhook attive e con una sottoscrizione di eventi abilitata.
- Tipo di abbonamento all'evento:inserisci il tipo di evento che vuoi utilizzare per attivare l'integrazione.
- Service account: seleziona un account di servizio con i ruoli IAM richiesti per il trigger webhook.
- Fai clic su Fine per completare la configurazione dell'attivatore e chiudere la pagina.
Configurare il trigger webhook utilizzando una nuova connessione
Per configurare il trigger webhook utilizzando una nuova connessione webhook, segui questi passaggi:
- Fai clic sull'elemento Webhook trigger nell'Editor integrazioni per aprire il riquadro di configurazione del trigger.
- Fai clic su Configura trigger.
- Ignora il campo Regione.
- Fai clic su Connessione e seleziona l'opzione Crea connessione dal menu.
- Completa i seguenti passaggi nel riquadro Crea connessione:
- Nella sezione Località, scegli la località per la connessione.
- Regione: seleziona una località dall'elenco.
Le regioni supportate per i connettori includono:
Per l'elenco di tutte le regioni supportate, consulta Località.
- Fai clic su Avanti.
- Regione: seleziona una località dall'elenco.
- Nella sezione Dettagli connessione, completa quanto segue:
- Connettore: seleziona Webhook dall'elenco a discesa dei connettori disponibili.
- Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
- Nome connessione: inserisci un nome per l'istanza di connessione.
I nomi delle connessioni devono soddisfare i seguenti criteri:
- I nomi delle connessioni possono contenere lettere, numeri o trattini.
- Le lettere devono essere minuscole.
- I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
- I nomi delle connessioni non possono contenere più di 49 caratteri.
- Per i connettori che supportano la sottoscrizione agli eventi, i nomi delle connessioni non possono iniziare con il prefisso "goog".
- Descrizione: (facoltativo) inserisci una descrizione per l'istanza di connessione.
- Service Account: seleziona un account di servizio con i ruoli richiesti.
- Abbonamento agli eventi: l'abbonamento agli eventi sarà attivato per impostazione predefinita ed è obbligatorio per il connettore webhook.
- (Facoltativo) Fai clic su + Aggiungi etichetta per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
- Fai clic su Avanti.
-
Nella sezione Dettagli sottoscrizione agli eventi, completa quanto segue:
- Autenticazione listener: seleziona un tipo di autenticazione per il listener di eventi e inserisci i dettagli pertinenti.
Il listener webhook supporta i seguenti tipi di autenticazione:
- Nessuna autenticazione
- Autenticazione Google: assicurati che il account di servizio disponga del ruolo roles/connectors.listener il cui token di accesso viene utilizzato per l'autenticazione.
- Autenticazione con chiave API
- Autenticazione di base
- Posizione del campo Tipo di evento: campo obbligatorio che indica la posizione (intestazione, parametro di query o corpo della richiesta) in cui sarà presente il tipo di evento associato alla richiesta di evento in entrata.
- Event Type Field Name (Nome campo tipo di evento): campo obbligatorio nella posizione configurata che identifica il tipo di evento associato alla richiesta di evento in entrata.
- Seleziona Attiva connettività privata per una connettività sicura tra l'applicazione di backend e la connessione. Se selezioni questa opzione, devi eseguire passaggi di configurazione aggiuntivi dopo aver creato la connessione. Per saperne di più, consulta Connettività privata per l'abbonamento agli eventi.
- Inserisci la configurazione della coda di messaggi non recapitabili. Se configuri la coda dei messaggi non recapitabili, la connessione scrive
gli eventi non elaborati nell'argomento Pub/Sub specificato. Inserisci i seguenti dettagli:
- ID progetto messaggi non recapitabili : l'ID progetto Google Cloud in cui hai configurato l'argomento Pub/Sub messaggi non recapitabili.
- Argomento messaggi non recapitabili : l'argomento Pub/Sub in cui vuoi scrivere i dettagli dell'evento non elaborato.
- Fai clic su Avanti.
Nell'esempio precedente, il campo event_type nel corpo della richiesta indica che la richiesta riguarda un evento "user.created".{ "event_type": "user.created", ... // other request fields ... }
- Autenticazione listener: seleziona un tipo di autenticazione per il listener di eventi e inserisci i dettagli pertinenti.
- Revisione: rivedi i dettagli della connessione e dell'autenticazione del listener.
- Fai clic su Crea.
- Nella sezione Località, scegli la località per la connessione.
Output trigger
Il trigger webhook richiede un paio di minuti per completare la configurazione della sottoscrizione agli eventi. Puoi visualizzare lo stato dell'iscrizione all'evento nel riquadro di configurazione del trigger in Dettagli iscrizione all'evento.
Il trigger webhook indica lo stato di un abbonamento a un evento utilizzando i seguenti stati:
Creating
: indica che il trigger è l'iscrizione all'abbonamento all'evento.Active
: indica che l'attivatore è stato iscritto correttamente a un abbonamento agli eventi.Error
: indica che si è verificato un problema con l'abbonamento agli eventi configurato.
Oltre allo stato dell'abbonamento agli eventi, la sezione Dettagli abbonamento agli eventi mostra anche altri dettagli, come la regione di connessione, il nome della connessione, il nome dell'abbonamento agli eventi e altro ancora.
Variabile di output del trigger
Per ogni evento, il trigger webhook genera una variabile di output ConnectorEventPayload
che puoi utilizzare nelle attività downstream. La variabile di output è in formato JSON e contiene lo schema del payload del webhook di output.
Visualizzare le iscrizioni agli eventi
Per visualizzare e gestire tutti gli abbonamenti agli eventi associati a una connessione in Integration Connectors:
- Vai alla pagina Integration Connectors > Connections (Connettori di integrazione > Connessioni).
- Fai clic sulla connessione per cui vuoi visualizzare gli abbonamenti.
- Fai clic sulla scheda Abbonamenti agli eventi.
Vengono visualizzate tutte le iscrizioni agli eventi per la connessione.
Modifica trigger webhook
Puoi modificare un trigger webhook per cambiare o aggiornare la configurazione della connessione e i dettagli dell'iscrizione agli eventi.
Per modificare un trigger webhook:
- Fai clic sull'elemento Webhook trigger nell'Editor integrazioni per aprire il riquadro di configurazione del trigger.
- Fai clic su Configura attivatore webhook.
- Nella pagina Editor trigger evento connettore, segui questi passaggi:
- Per mantenere l'abbonamento agli eventi configurato in precedenza, fai clic su Mantieni, altrimenti fai clic su Elimina.
- Aggiorna la configurazione della connessione e i dettagli dell'iscrizione agli eventi come preferisci.
- Fai clic su Fine.
Puoi visualizzare i dettagli aggiornati della connessione e della sottoscrizione agli eventi nel riquadro di configurazione del trigger in Dettagli sottoscrizione agli eventi.
Quote e limiti
Per informazioni su quote e limiti, consulta Quote e limiti.
Passaggi successivi
- Scopri di più su tutte le attività e tutti gli attivatori.
- Scopri come testare e pubblicare un'integrazione.
- Scopri di più sulla gestione degli errori.
- Scopri di più sui log di esecuzione dell'integrazione.