Trigger Webhook

I Webhook sono un tipo di flusso di eventi che consente a prodotti, fornitori o servizi di inviare comunicazioni in tempo reale al nostro sistema. Essi elaborano e arricchiscono i dati da inviare da servizi e piattaforme di terze parti ai record della nostra soluzione.

Suggerimento: Fai clic su Salva o Salva e Chiudi dopo aver apportato modifiche.

Visualizza Webhook Esistenti

Per visualizzare i webhook esistenti:

Vai a ORCHESTRATION.
Fai clic su Webhook.

Da qui puoi attivare o disattivare il pulsante Abilitato, o fare clic sul webhook desiderato per visualizzare le impostazioni e le informazioni di log.

Crea Trigger Webhook

Per creare un trigger webhook, crea un nuovo playbook, carica un playbook esistente o cerca un playbook esistente.

Nel playbook, fai clic su Aggiungi trigger.
Fai clic su Cattura Webhook.
Su TRIGGER, inserisci un titolo per il webhook e fai clic su Genera URL altrimenti il webhook non verrà creato.

Dopo che il pulsante Genera URL è stato premuto, l'URL del webhook viene generato nel campo Webhook URL e il collegamento Copia URL viene abilitato.

Successivamente, puoi modificare le impostazioni del webhook.

Modifica Impostazioni Webhook

Per modificare le impostazioni del webhook:

Su TRIGGER, fai clic su Modifica Webhook.
Nella scheda IMPOSTAZIONI, puoi aggiornare il titolo del webhook, aggiungere proprietà per autenticare le richieste del webhook, copiare l'URL ed abilitare/disabilitare il webhook.
Nella scheda LOG, puoi visualizzare i log del webhook, visualizzare per data ed abilitare/disabilitare il webhook.
Fai clic su Salva e Chiudi per salvare le modifiche.

Se non è necessario modificare il webhook, è possibile passare direttamente alla configurazione.

Configura Webhook

Sei pronto per iniziare il processo di configurazione del tuo webhook. Fai clic su Configura per iniziare. La finestra di configurazione del webhook ha tre schede: Eventi Webhook, Output e Mappa agli Input del Playbook.

Scheda Eventi Webhook

Questa scheda mostra il tipo di evento con un menu a discesa, che mostra i dettagli del webhook, il risultato e gli output scoperti.

Scheda Output

Questa scheda mostra tutti gli output del webhook. Questi sono tipi di proprietà predefiniti. Se hai aggiunto output scoperti, allora compariranno con l'iperlink Elimina. Qualsiasi tipo di proprietà senza quell'iperlink Elimina fa parte degli input restituiti originali dal webhook.

Scheda Mappa agli Input del Playbook

Proprio come gli input dell'azione, puoi fare clic su Aggiungi proprietà per vedere il menu a discesa. Puoi aggiungere una proprietà del playbook o un'espressione. Selezionando Proprietà del playbook apre il cassetto delle proprietà dove puoi selezionare la proprietà desiderata da mappare.

Proprietà $event.data

Ecco l'elenco delle proprietà di primo livello definite sull'oggetto $event.data:

url (oggetto): I componenti URL della richiesta.
href (stringa): L'URL completo della richiesta.
protocol (stringa): Il protocollo utilizzato per la richiesta.
hostname (stringa): Il nome host della richiesta.
port (numero intero): La porta della richiesta.
pathname (stringa): Il percorso della richiesta.
query (oggetto): I parametri di query della richiesta come coppie chiave/valore.
hash (stringa): L'hash della richiesta.
headers (oggetto): Gli header della richiesta come coppie chiave/valore.
body (nullo|array|booleano|numero|oggetto|stringa): Il corpo JSON della richiesta.

Autenticare Webhook

Per configurare le impostazioni di autenticazione del webhook:

Su TRIGGER, fai clic su Modifica Webhook.
Nella scheda IMPOSTAZIONI, fai clic su Aggiungi proprietà, quindi fai clic su Autenticazione.

Il campo Autorizzazione viene visualizzato con un'opzione di sotto proprietà.

Fai clic su Aggiungi proprietà.
Seleziona Autenticazione di Base o Autenticazione con Segreto Condiviso.

Autenticazione di Base

L'autenticazione di base specifica le credenziali da inviare, verificate dall'Authorization header utilizzando il meccanismo di autenticazione di base.

Dopo aver selezionato Autenticazione di Base, completa i campi Nome Utente e Password, e fai clic su Salva. Rifletti il nome utente e la password con il tuo sistema di terze parti.

Importante! Credenziali non corrispondenti comporteranno una risposta 401 non autorizzata alle richieste del webhook, ma non genereranno un messaggio di errore.

Per rimuovere l'autenticazione di base, fai clic sui tre punti verticali, quindi fai clic su Rimuovi.

Autenticazione con Segreto Condiviso

L'autenticazione con segreto condiviso specifica le credenziali da inviare, verificate da uno dei seguenti luoghi nelle richieste del webhook: header, body o parametro di query.

Dopo aver selezionato Shared Secret Authentication, completa i campi Secret, Secret format e Secret location.

Per completare Secret location, fai clic su Aggiungi proprietà.

Dal menu a discesa, seleziona la proprietà Corpo della Richiesta, Header della Richiesta o Parametro di Query della Richiesta per:

Estrarre il segreto (Password) dal corpo della richiesta.
Estrarre il segreto (Password) dall'header della richiesta.
Estrarre il segreto (Password) da un parametro di query.

Per rimuovere le proprietà, fai clic sui tre punti verticali, quindi fai clic su Rimuovi.

Visualizzare i Log del Webhook

Per visualizzare i log del webhook su TRIGGER, fai clic su Modifica Webhook e fai clic sulla scheda Log.
Puoi visualizzare i log, abilitare o disabilitare il webhook o filtrare per data cliccando su Vai alla data.