Webhook
Un webhook è una chiamata HTTP attivata da un evento. Puoi utilizzare i webhook per attivare moduli di attivazione istantanea. Qualsiasi applicazione connessa a Internet e che consenta le richieste HTTP può inviare webhook ad Adobe Workfront Fusion.
Requisiti di accesso
Per utilizzare le funzionalità di questo articolo, è necessario disporre dei seguenti diritti di accesso:
*Per conoscere il piano, il tipo di licenza o l'accesso di cui si dispone, contattare l'amministratore Workfront.
**Per informazioni su Adobe Workfront Fusion licenze, consulta Adobe Workfront Fusion licenze
Utilizzare un webhook in Workfront Fusion
Per utilizzare un webhook per connettere un’app a Workfront Fusion:
-
Aggiungi il Webhook >Webhook personalizzato modulo di attivazione istantanea per lo scenario.
-
Clic Aggiungi accanto al campo webhook e immettere un nome per il nuovo webhook.
-
(Facoltativo) Fai clic su Impostazioni avanzate.
-
In Restrizioni IP , inserisci un elenco separato da virgole degli indirizzi IP da cui il modulo può accettare i dati.
-
Fai clic su Salva
Dopo aver creato un webhook, viene visualizzato un URL univoco. Questo è l’indirizzo a cui il webhook invia i dati. Workfront Fusion convalida i dati inviati a questo indirizzo, quindi li trasmette per l’elaborazione nello scenario.
Configurare la struttura dati del webhook configure-the-webhook-s-data-structure
Al fine di riconoscere la struttura dati del payload in ingresso, Workfront Fusion analizza i dati di esempio inviati all'indirizzo visualizzato. Puoi fornire i dati di esempio apportando una modifica al servizio o all’app che farà sì che il servizio o l’app chiamino il webhook. Ad esempio, puoi rimuovere un file.
Oppure puoi seguire i passaggi seguenti per inviare i dati di esempio tramite il HTTP > Fai una richiesta modulo.
-
Crea un nuovo scenario con HTTP > Fai una richiesta modulo
-
Configura il modulo con i seguenti valori:
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header URL Immetti l’URL del webhook. È possibile trovare questo URL nel modulo Webhooks utilizzato per configurare il webhook. Method POST Tipo di corpo Raw Tipo di contenuto JSON (application/json) Contenuto richiesta JSON non elaborato previsto nel webhook -
Apri lo scenario con Webhook in una scheda o finestra del browser separata.
-
Nel modulo webhooks, fai clic su Rideterminare la struttura dei dati.
Non è necessario scollegare altri moduli dal modulo webhooks.
-
Passa allo scenario con HTTP ed eseguirlo.
-
Torna allo scenario con il modulo Webhooks.
A "Determinato correttamenteIl messaggio "indica che il modulo ha determinato correttamente la struttura dati.
-
Clic OK per salvare la struttura dati.
Gli elementi del webhook sono ora disponibili nel pannello di mappatura per l’utilizzo con i moduli successivi nello scenario.
Coda
Se un webhook riceve dati e non esiste uno scenario attivo che preveda tali dati, questi vengono memorizzati nella coda. Una volta attivato lo scenario, elabora in sequenza tutti i bundle in attesa nella coda.
Formati di dati in arrivo supportati
Workfront Fusion supporta 3 formati di dati in arrivo: Stringa di query, Dati modulo e JSON.
Workfront Fusion convalida tutti i dati in arrivo in base alla struttura dati selezionata. Quindi, a seconda delle impostazioni dello scenario, i dati vengono memorizzati nella coda per l’elaborazione o vengono elaborati immediatamente.
Se una parte qualsiasi dei dati non supera la convalida, Workfront Fusion restituisce un codice di stato HTTP 400 e specifica, nel corpo della risposta HTTP, il motivo per cui i controlli di convalida dei dati in arrivo non sono riusciti. Se la convalida dei dati in arrivo ha esito positivo, Workfront Fusion restituisce un "200 accettati".
Stringa di query
GET https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>?name=<yourname>&job=automate
Dati modulo
POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>
Content-Type: application/x-www-form-urlencoded
name=<yourname>&job=automate
Dati modulo multipart
POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>
Content-Type: multipart/form-data; boundary=---generatedboundary
---generatedboundary
Content-Disposition: form-data; name="file"; filename="file.txt"
Content-Type: text/plain
Content of file.txt
---generatedboundary
Content-Disposition: form-data; name="name"
Workfront Fusion
---generatedboundary
Per ricevere i file codificati con multipart/form-data
, è necessario configurare una struttura dati con collection
campo di tipo contenente i campi nidificati name
, mime
, e data
. Il campo name
è un text
e contiene il nome del file caricato. Il mime
è un text
e contiene un file in formato MIME. Il campo data
è un buffer
e contiene dati binari per il file da trasferire.
Per ulteriori informazioni sul formato MIME, vedi Moduli MIME.
JSON
POST https://app.workfrontfusion.com/wh/<yourunique32characterslongstring>
Content-Type: application/json
{"name": "Workfront Fusion", "job": "automate"}
- Clic Aggiungi per aggiungere un nuovo webhook.
- Clic Mostra impostazioni avanzate.
- Clic Pass-through JSON.
Intestazioni webhook
Per accedere alle intestazioni del webhook, abilita Ottieni intestazioni di richiesta durante la configurazione del webhook.
- Clic Aggiungi per aggiungere un nuovo webhook.
- Clic Mostra impostazioni avanzate.
- Clic Ottieni intestazioni richiesta.
Puoi estrarre un particolare valore di intestazione con la combinazione di map()
e get()
funzioni.
authorization
intestazione da Headers[]
array. La formula viene utilizzata in un filtro che confronta il valore estratto con il testo specificato per trasmettere solo i webhook in caso di corrispondenza.![](./media_19c00f8fc112a80577c8c86c6266afbddded0c0fb.png?width=750&format=png&optimize=medium)
Risposta ai webhook
La risposta predefinita a una chiamata al webhook è il testo "Accepted" (Accettato). La risposta viene restituita all’app che ha chiamato il webhook durante l’esecuzione del modulo Webhook personalizzato.
Verificare la risposta a un webhook
-
Includi Webhook personalizzato nel tuo scenario.
-
Aggiungi un nuovo webhook al modulo.
-
Copia l’URL del webhook negli Appunti.
-
Esegui lo scenario.
L'icona del fulmine sul Webhook personalizzato Il modulo diventa un punto in rotazione. Questo mostra che il modulo è ora in attesa della chiamata del webhook.
-
Apri una nuova finestra del browser, incolla l’URL copiato nella barra degli indirizzi e premi Invio.
Il Webhook personalizzato viene attivato e il browser visualizza una nuova pagina.
Se desideri personalizzare la risposta del webhook, utilizza il modulo Risposta del webhook.
La configurazione del modulo contiene due campi: Stato e Corpo.
-
Il Stato contiene codici di stato di risposta HTTP come 2xx per il successo (ad esempio,
200
per OK), 3xx per Redirection (ad esempio,307
per il reindirizzamento temporaneo), 4xx per gli errori del client (ad esempio,400
per la richiesta non valida) e così via. -
Il Corpo contiene tutto ciò che verrà accettato dalla chiamata del webhook. Può essere testo semplice, HTML, XML, JSON e così via.
note tip TIP È consigliabile impostare Content-Type
intestazione al tipo MIME corrispondente:text/plain
per il testo normale,text/html
per HTML,application/json
per JSON,application/xml
per XML e così via. Per ulteriori informazioni sui tipi MIME, vedi Moduli MIME.
Il timeout per l’invio di una risposta è di 40 secondi. Se la risposta non è disponibile entro tale periodo, Workfront Fusion restituisce lo stato "200 Accepted" (Accettato).
Esempio di risposta HTML
table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
---|---|
Stato | Codice di stato HTTP 2xx, ad esempio 200 |
Body | Codice HTML |
Intestazioni personalizzate |
>
|
![](./media_1d61e5a53f6b451ba003c3341c8f1b97254929124.png?width=750&format=png&optimize=medium)
![](./media_18706152db0153d4e098de351c3b9b77da0c403af.png?width=750&format=png&optimize=medium)
Esempio di reindirizzamento
table 0-row-2 1-row-2 layout-auto html-authored no-header | |
---|---|
Stato | Codice di stato HTTP del reindirizzamento 3xx, ad esempio 303 |
Intestazioni personalizzate |
>
|
![](./media_1fcda5a926af051ce508d0d8c22bdb44634a44a54.png?width=750&format=png&optimize=medium)
Disattivazione webhook
I webhook vengono disattivati automaticamente se si applica una delle seguenti condizioni:
- Il webhook non è stato connesso ad alcuno scenario per più di 5 giorni
- Il webhook viene utilizzato solo in scenari inattivi, che sono stati inattivi per più di 30 giorni.
I webhook disattivati vengono eliminati e annullati automaticamente se non sono connessi ad alcun scenario e se sono in stato disattivato da oltre 30 giorni.
Risoluzione dei problemi
Elementi mancanti nel pannello di mappatura
Se nel pannello di mappatura mancano alcuni elementi nella configurazione dei moduli che seguono Webhook > Webhook personalizzato , fai clic sul pulsante Webhook > Webhook personalizzato per aprire la relativa configurazione e fare clic su Rideterminare la struttura dei dati:
Quindi segui i passaggi descritti nella sezione Configurare la struttura dati del webhook in questo articolo.