# Einbindungen (Integrations)



# Webhook

## Einleitung

Webhooks in ERPNext "...ermöglichen es, einer [Server](https://de.wikipedia.org/wiki/Server "Server")-Software mitzuteilen, dass ein bestimmtes [Ereignis](https://de.wikipedia.org/wiki/Ereignis_(Programmierung) "Ereignis (Programmierung)") eingetreten ist und eine Reaktion auf das Ereignis auszulösen. Wenn eine Anwendung über ein eingetretenes Ereignis mittels WebHook informiert, müssen an dem Ereignis interessierte andere Anwendungen kein [Polling](https://de.wikipedia.org/wiki/Polling_(Informatik) "Polling (Informatik)") betreiben, um von dem Ereignis Kenntnis zu erlangen. Das reduziert das Nachrichtenaufkommen zwischen den Anwendungen. " (quelle: [https://de.wikipedia.org/wiki/Webhooks](https://de.wikipedia.org/wiki/Webhooks))

## Übersicht

<div drawio-diagram="3618"><img src="https://doku.phamos.eu/uploads/images/drawio/2023-04/drawing-4-1682190828.png" alt=""/></div>

## Felder

### Dokumentenereignise

<table border="1" id="bkmrk-bezeichnung-feldname" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">**Bezeichnung**  
</td><td style="width: 33.2922%;">**Feldname**  
</td><td style="width: 33.2922%;">**Erklärung**  
</td></tr><tr><td style="width: 33.2922%;">Nummernkreis  
</td><td style="width: 33.2922%;">naming\_series  
</td><td style="width: 33.2922%;">  
</td></tr><tr><td style="width: 33.2922%;">DocType  
</td><td style="width: 33.2922%;">webhook\_doctype  
</td><td style="width: 33.2922%;">Verknüpfung zum DocType auf welchem der Webhook geschaltet werden soll.  
</td></tr><tr><td style="width: 33.2922%;">Dokumentenereignis  
</td><td style="width: 33.2922%;">webhook\_docevent  
</td><td style="width: 33.2922%;">Folgende Auswahl steht uns zur Verfügung

- nach\_einfügen
- on

</td></tr><tr><td style="width: 33.2922%;">Aktiviert  
</td><td style="width: 33.2922%;">enabled  
</td><td style="width: 33.2922%;">Haken setzen um den Webhook scharf zu schalten.  
</td></tr></tbody></table>

### Webhook-Auslöser

<table border="1" id="bkmrk-bezeichnung-feldname-0" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">**Bezeichnung**  
</td><td style="width: 33.2922%;">**Feldname**  
</td><td style="width: 33.2922%;">**Erklärung**  
</td></tr><tr><td style="width: 33.2922%;">Zustand  
</td><td style="width: 33.2922%;">condition  
</td><td style="width: 33.2922%;">  
</td></tr></tbody></table>

### Webhook Anfrage

<table border="1" id="bkmrk-bezeichnung-feldname-1" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">**Bezeichnung**  
</td><td style="width: 33.2922%;">**Feldname**  
</td><td style="width: 33.2922%;">**Erklärung**  
</td></tr><tr><td style="width: 33.2922%;">URL anfordern  
</td><td style="width: 33.2922%;">request\_url  
</td><td style="width: 33.2922%;">Hier tragen wir die URL ein an welche die Aktion (request Method) des Webhooks gesendet werden soll.

[<span style="text-decoration: underline;">Weitere Erklärungen</span>](https://doku.phamos.eu/link/1918#bkmrk-url-anfordern)

</td></tr><tr><td style="width: 33.2922%;">Request Method  
</td><td style="width: 33.2922%;">request\_method  
</td><td style="width: 33.2922%;">Zur Auswahl stehen:

- POST
- PUT
- DELETE

</td></tr><tr><td style="width: 33.2922%;">Struktur anfordern  
</td><td style="width: 33.2922%;">request\_structure  
</td><td style="width: 33.2922%;">Zur Auswahl stehen:

- Formular URL-verschlüsselt
- JSON

</td></tr></tbody></table>

### Webhook-Sicherheit

<table border="1" id="bkmrk-bezeichnung-feldname-2" style="border-collapse: collapse; width: 100%; height: 106.2px;"><tbody><tr style="height: 29.8px;"><td style="width: 33.2922%; height: 29.8px;">**Bezeichnung**  
</td><td style="width: 33.2922%; height: 29.8px;">**Feldname**  
</td><td style="width: 33.2922%; height: 29.8px;">**Erklärung**  
</td></tr><tr style="height: 46.6px;"><td style="width: 33.2922%; height: 46.6px;">Sicherheit aktivieren  
</td><td style="width: 33.2922%; height: 46.6px;">enable\_security  
</td><td style="width: 33.2922%; height: 46.6px;">Häkchen um einzustellen, dass die URL eine Authentifizierung erfordert.  
</td></tr><tr style="height: 29.8px;"><td style="width: 33.2922%; height: 29.8px;">Webhook-Geheimnis  
</td><td style="width: 33.2922%; height: 29.8px;">webhook\_secret  
</td><td style="width: 33.2922%; height: 29.8px;">Dieses Pflichtfeld ist nur dann sichtbar, wenn enable\_security aktiviert ist.

Hier tragen wir das erforderliche Kenntwort für die Authentifizierung an request\_url notwendig ist.

</td></tr></tbody></table>

### Webhook Header

##### Headers

<table border="1" id="bkmrk-bezeichnung-feldname-3" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">**Bezeichnung**  
</td><td style="width: 33.2922%;">**Feldname**  
</td><td style="width: 33.2922%;">**Erklärung**  
</td></tr><tr><td style="width: 33.2922%;">Schlüssel  
</td><td style="width: 33.2922%;">key  
</td><td style="width: 33.2922%;">  
</td></tr><tr><td style="width: 33.2922%;">Wert  
</td><td style="width: 33.2922%;">value  
</td><td style="width: 33.2922%;">  
</td></tr></tbody></table>

### Webhook Daten

##### Daten

<table border="1" id="bkmrk-bezeichnung-feldname-4" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">**Bezeichnung**  
</td><td style="width: 33.2922%;">**Feldname**  
</td><td style="width: 33.2922%;">**Erklärung**  
</td></tr><tr><td style="width: 33.2922%;">Feldname  
</td><td style="width: 33.2922%;">fieldname  
</td><td style="width: 33.2922%;">  
</td></tr><tr><td style="width: 33.2922%;">Schlüssel  
</td><td style="width: 33.2922%;">key  
</td><td style="width: 33.2922%;">  
</td></tr></tbody></table>

## Erklärungen

### Webhook Anfrage

##### URL anfordern

Zum testen kann z.B. die Seite [https://webhook.site](https://webhook.site) verwendet werden. Nutzt man diese Seite muss man ggf. eine Zeile aus der Datei `frappe/frappe/integrations/doctype/webhook/webhook.py` auskommentieren, damit wir ein Feedback in [<span style="text-decoration: underline;">Webhook Request Log</span>](https://doku.phamos.eu/books/erpnext-benutzerhandbuch/page/webhook-request-log "Webhook Request Log") finden. Andernfalls sehen wir nur eine Meldung im [Error Log](https://doku.phamos.eu/books/erpnext-benutzerhandbuch/page/fehlerprotokoll-error-log "Fehlerprotokoll (Error Log)").

[![image-1683659890373.png](https://doku.phamos.eu/uploads/images/gallery/2023-05/scaled-1680-/image-1683659890373.png)](https://doku.phamos.eu/uploads/images/gallery/2023-05/image-1683659890373.png)

## Logging und Debugging  


### Webhook Request Log

Hier können wir die Ergebnisse der Webhook-Aufrufe einsehen.

### Fehlerprotokoll

Nicht alles wird im Webhook Request Log angezeigt. Weiteres logging passiert im [<span style="text-decoration: underline;">Fehlerprotokoll</span>](https://doku.phamos.eu/books/erpnext-benutzerhandbuch/page/fehlerprotokoll-error-log "Fehlerprotokoll (Error Log)") des Systems.

# Webhook Request Log

## Einleitung

[![image-1682189877820.png](https://doku.phamos.eu/uploads/images/gallery/2023-04/scaled-1680-/image-1682189877820.png)](https://doku.phamos.eu/uploads/images/gallery/2023-04/image-1682189877820.png)

## Felder

<table border="1" id="bkmrk-bezeichnung-feldname" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">**Bezeichnung**  
</td><td style="width: 33.2922%;">**Feldname**  
</td><td style="width: 33.2922%;">**Erklärung**  
</td></tr><tr><td style="width: 33.2922%;">User  
</td><td style="width: 33.2922%;">  
</td><td style="width: 33.2922%;">  
</td></tr><tr><td style="width: 33.2922%;">Header  
</td><td style="width: 33.2922%;">  
</td><td style="width: 33.2922%;">  
</td></tr><tr><td style="width: 33.2922%;">Data  
</td><td style="width: 33.2922%;">  
</td><td style="width: 33.2922%;"> </td></tr><tr><td style="width: 33.2922%;">URL  
</td><td style="width: 33.2922%;">  
</td><td style="width: 33.2922%;">  
</td></tr><tr><td style="width: 33.2922%;">Response  
</td><td style="width: 33.2922%;">  
</td><td style="width: 33.2922%;">  
</td></tr></tbody></table>

## Erweitertes Logging

Im Webhook Request Log sehen wir nicht alle Informationen. Weitere Logs werden im <span style="text-decoration: underline;">[Fehlerprotokoll](https://doku.phamos.eu/books/erpnext-benutzerhandbuch/page/fehlerprotokoll-error-log "Fehlerprotokoll (Error Log)")</span> geschrieben.