Documentation
Table of Contents
4 Webhook
Vista general
El tipus de suport web hook ¨¦s ¨²til per fer crides HTTP mitjan?ant codis JavaScript personalitzats per a una f¨¤cil integraci¨® amb programari extern, com ara sistemes d'assist¨¨ncia, xats o missatgeria. Podeu triar importar una integraci¨® proporcionada per Áú»¢¶Ä²© o crear una integraci¨® personalitzada des de zero.
Integracions
Les integracions seg¨¹ents s¨®n disponibles per permetre emprar tipus de suport web predefinits per enviar les notificacions de Áú»¢¶Ä²© a:
A m¨¦s dels serveis llistats aqu¨ª, Áú»¢¶Ä²© es pot integrar amb Spiceworks (no cal cap webhook). Per convertir les notificacions de Áú»¢¶Ä²© en entrades d'Spiceworks, creeu un tipus de suport de correu-e i introdu?u l'adre?a de correu electr¨°nic del servei d'assist¨¨ncia de Spiceworks (p. ex. [email protected]) a la configuraci¨® del perfil d'un usuari designat de Áú»¢¶Ä²©.
°ä´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨®
Per comen?ar a emprar una integraci¨® de webhook:
- Localitzeu el fitxer .xml necessari al directori
templates/mediade la versi¨® de Áú»¢¶Ä²© baixada o descarregueu-lo des del de Áú»¢¶Ä²©. - Importeu el fitxer a la instal¡¤laci¨® de Áú»¢¶Ä²©. El webhook apareixer¨¤ a la llista de tipus de suports.
- Configureu el webhook segons les instruccions del fitxer Readme.md (podeu fer clic al nom d'un webhook a dalt per accedir r¨¤pidament a Readme.md).
Per crear un webhook personalitzat des de zero:
- Aneu a Alertes ¡ú Tipus de suport
- Feu clic a Crea un tipus de suport
La pestanya Tipus de suport cont¨¦ diversos atributs espec¨ªfics d'aquest tipus de suport:
Tots els camps d'entrada obligatoris s¨®n marcats amb un asterisc vermell.
Els par¨¤metres seg¨¹ents s¨®n espec¨ªfics del tipus de suport de webhook:
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ðs | Especifiqueu les variables del webhook com a parelles d'atribut i valor. Per als webhooks preconfigurats, una llista de par¨¤metres varia segons el servei. Comproveu el fitxer Readme.md del webhook per a la descripci¨® del par¨¤metre. Per als webhooks nous, s'inclouen diverses variables habituals de manera predeterminada (URL:<buit>, HTTPProxy:<buit>, Per a:{ALERT.SENDTO}, Assumpte: {ALERT.SUBJECT}, Missatge:{ALERT.MESSAGE}), no dubteu a conservar-los o esborrar-los. Totes les macros admeses a les notificacions de problemes s'admeten al par¨¤metres. Si especifiqueu un proxy HTTP, el camp suporta la mateixa funcionalitat que al camp de configuraci¨® de l'element proxy HTTP. La cadena de proxy pot tindre el prefix [scheme]:// per especificar quin tipus de proxy s'empra (p. ex. https, socks4, socks5; veieu la ). |
| Script | Introdu?u el codi JavaScript a l'editor modal que s'obre quan cliquem al camp de par¨¤metres, o a la icona de text del ll¨¤pis que hi ha al costat. Aquest codi realitzar¨¤ l'operaci¨® webhook. L'script ¨¦s un codi de funci¨® que accepta par¨¤metres - valor. Els valors s'han de convertir en objectes JSON mitjan?ant el m¨¨tode JSON.parse(), per exemple: var params = JSON.parse(value);.El codi t¨¦ acc¨¦s a tots els par¨¤metres, pot fer peticions HTTP, GET, POST, PUT i DELETE i t¨¦ control sobre les cap?aleres HTTP i el cos de la petici¨®. L'script ha de contindre un operador de retorn, en cas contrari, no ser¨¤ v¨¤lid. Pot tornar l'estat correcte juntament amb un llistat opcional d'etiquetes i valors d'etiquetes (veieu l'opci¨® Etiquetes de proc¨¦s) o una cadena d'error. Tingueu en compte que l'script nom¨¦s s'executa despr¨¦s de crear una alerta. Si l'script ¨¦s configurat per tornar i processar etiquetes, aquestes etiquetes no es resoldran a les macros {EVENT.TAGS} i {EVENT.RECOVERY.TAGS} al missatge de problema inicial i als missatges de recuperaci¨® perqu¨¨ l'script no ha tingut temps d'executar-se encara. Nota: Es recomana emprar variables locals enlloc de globals, per assegurar que cada script s'executa amb els seus propis par¨¤metres i no hi ha pas conflicte entre crides concurrents (veieu els problemes coneguts). Veieu tamb¨¦: Directrius de desenvolupament de Webhook, Exemples d'scripts de Webhook, Objectes JavaScript addicionals. |
| Temps d'espera | Temps d'espera d'execuci¨® de JavaScript (1-60s, 30s per defecte). S'admeten sufixos de temps, com ara 30 anys, 1m. |
| Etiquetes de processos | Marqueu la casella de selecci¨® per processar els valors de propietat JSON retornats com a etiquetes. Aquestes etiquetes s'afegeixen a les etiquetes d'esdeveniment de problemes ja existents (si n'hi han) a Áú»¢¶Ä²©. Si un webhook empra etiquetes (la casella de selecci¨® Processar etiquetes ¨¦s marcada), el webhook sempre hauria de retornar un objecte JSON que contingui almenys un objecte buit per a tags: var resultat = {etiquetes: {}};.Exemples d'etiquetes que es poden retornar: jira-id: prod-1234, Responsable: john smith, processat:<sense valor> , etc. |
| Incloure l'entrada del men¨² d'esdeveniments | Marqueu la casella de selecci¨® per incloure una entrada al men¨² d'esdeveniment que enlla?a amb el bitllet extern creat. Si ¨¦s marcat, el webhook no s'ha d'emprar per enviar notificacions a diferents usuaris (considereu crear un usuari dedicat) o a diverses accions d'alerta relacionades amb un sol esdeveniment problema. |
| Nom de l'entrada del men¨² | Especifiqueu el nom de l'entrada del men¨². La macro {EVENT.TAGS.<nom de l'etiqueta>} ¨¦s compatible. Aquest camp nom¨¦s ¨¦s obligatori si ¨¦s seleccionat Inclou l'entrada del men¨² d'esdeveniments. |
| URL de l'entrada del men¨² | Especifiqueu l'URL subjacent de l'entrada del men¨². S'admet la macro {EVENT.TAGS.<nom de l'etiqueta>}. Aquest camp nom¨¦s ¨¦s obligatori si ¨¦s seleccionat Inclou l'entrada del men¨² d'esdeveniments . |
Veieu par¨¤metres de tipus de mitjans comuns per obtindre informaci¨® sobre com configurar els missatges predeterminats i les opcions de processat d'alertes.
Fins i tot si un webhook no empra missatges predeterminats, les plantilles de missatges per als tipus d'operacions emprats per aquest webhook encara s'han de definir.
Prova de tipus de suport
Per provar un tipus de suport de webhook configurat:
- Localitzeu el webhook rellevant a la llista dels tipus de suport.
- Feu clic a Provar a la darrera columna de la llista (obrir¨¤ una finestra de prova).
- Editeu els valors dels par¨¤metres del webhook, si cal. Canviar macros amb valors d'exemple; altrament, les macros no es resoldran pas, i la prova fallar¨¤.
- Feu clic a Provar.
La substituci¨® o la supressi¨® de valors a la finestra de prova afecta nom¨¦s al procediment de prova; els valors reals dels atributs webhook es mantindran sense canvis.
Per veure les entrades del registre de prova de tipus de suport sense sortir de la finestra de prova, feu clic a Obrir el registre (s'obrir¨¤ una nova finestra emergent).
** Si el test de webhook ha funcionat: **
- Apareix el missatge "La prova de tipus de suport ha funcionat."
- La resposta del servidor apareix al camp gris Resposta
- El tipus de resposta (JSON o String) s'especifica al camp Resposta
** Si el test de webhook falla: **
- El missatge "Ha fallat el test de tipus de suport." es mostra, seguit de detalls suplementaris de l'error.
Suport d'usuari
Un cop configurat el tipus de suport, aneu a Administraci¨® ¡ú Usuaris i assigneu el suport del webhook a un usuari existent o creeu un usuari nou per representar el webhook. Les passes per configurar els suports d'usuari per a un usuari existent, comunes a tots els tipus de suports, es descriuen a la p¨¤gina Tipus de suport.
Si un webhook empra etiquetes per emmagatzemar l'ID del bitllet\missatge, eviteu assignar el mateix webhook com a suports a diferents usuaris, ja que aix¨° pot provocar errors de webhook (s'aplica a la majoria de webhooks que empren l'opci¨® Inclou l'entrada del men¨² d'esdeveniments). En aquest cas, la millor pr¨¤ctica ¨¦s crear un usuari dedicat per representar el webhook:
- Despr¨¦s de configurar el tipus de suport del webhook, aneu a la secci¨® Administraci¨® ¡ú Usuaris i creeu un usuari Áú»¢¶Ä²© dedicat per representar el webhook, per exemple, amb un nom d'usuari Slack per al webhook Slack. Totes les configuracions, excepte els suports, es poden deixar amb els seus valors predeterminats, ja que aquest usuari no iniciar¨¤ sessi¨® a Áú»¢¶Ä²©.
- Al perfil d'usuari, navegueu a la pestanya Suports i afegiu webhook amb la informaci¨® de contacte necess¨¤ria. Si el webhook no empra un camp Envia a, introdu?u qualsevol combinaci¨® de car¨¤cters admesos per ometre els requisits de validaci¨®.
- Concediu a aquest usuari almenys permisos per llegir tots els equips dels quals hauria d'enviar alertes.
Quan configureu l'acci¨® d'alerta, afegiu aquest usuari al camp Envia als usuaris als detalls de l'operaci¨®; aix¨° indicar¨¤ a Áú»¢¶Ä²© que empri el webhook per a les notificacions d'aquesta acci¨®.
°ä´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨® de les accions d'alertes
Les accions determinen quines notificacions s'han d'enviar mitjan?ant el webhook. Les passes per a configurar accions que involucren webhooks s¨®n les mateixes que per a tots els altres tipus de suport amb aquestes excepcions:
- Si un webhook empra etiquetes per emmagatzemar el bitllet\ID del missatge i per fer un seguiment de les operacions d'actualitzaci¨®\resoluci¨®, aquest webhook no s'hauria d'emprar a diverses accions d'alerta per a un ¨²nic esdeveniment problema. Si {EVENT.TAGS.<nom>} ja existeix i s'actualitza al webhook, el seu valor resultant no ser¨¤ definit. En aquest cas, s'ha d'emprar un nom d'etiqueta nova al webhook per emmagatzemar els valors actualitzats. Aix¨° s'aplica als webhooks Jira, Jira Service Desk, Mattermost, Opsgenie, OTRS, Redmine, ServiceNow, Slack, Zammad i Zendesk proporcionats per Áú»¢¶Ä²© i la majoria dels webhooks que empren l'opci¨® Inclou l'entrada del men¨². Es permet emprar el webhook en diverses operacions si aquestes operacions o passes d'escalat pertanyen a la mateixa acci¨®. Tamb¨¦ ¨¦s acceptable emprar aquest webhook en diferents accions si les accions no s'apliquen al mateix esdeveniment problem¨¤tic a causa de diferents condicions de filtre.
- Quan empreu un webhook en accions per a esdeveniments interns: a la configuraci¨® de l'operaci¨® d'acci¨®, marqueu la casella Missatge personalitzat i configureu el missatge personalitzat, en cas contrari, no hi haur¨¤ cap notificaci¨® quan s'envi?.