Mit Webhooks können Sie bei vorher definierten Aktionen eine Benachrichtigung (Event) an einen HTTP-Server (z.B. Ihre Webanwendung) verschicken.

Die Benachrichtigungen enthalten jeweils die zur Aktion relevanten Daten im JSON-Format.
Die enthaltenen Datenstrukturen können Sie unserer API-Dokumentation, Abschnitt Schemas im unteren Bereich, entnehmen.

Schema documentation: https://api.fakturia.de/documentation/
Section Schemas

Event TypeBeschreibung DEDescription ENSchema
(data object)
Kunde / Customer
CUSTOMER_CREATEDKunde angelegtCustomer createdAttribute: customer
Type: Customer
CUSTOMER_CHANGEDKunde geändertCustomer changedAttribute: customer
Type: Customer
CUSTOMER_DELETEDKunde gelöschtCustomer deletedAttribute: customer
Type: Customer
CUSTOMER_CHANGEREQUEST_CREATEDÄnderung der Kundendaten im Kundencenter beantragtChange of customer data requested in customer center

Attribute: changeCustomer
Type: ChangeCustomer

Artikel / Item
ITEM_CREATEDArtikel angelegtItem createdAttribute: item
Type: Item
ITEM_CHANGEDArtikel geändertItem changedAttribute: item
Type: Item
ITEM_DELETEDArtikel gelöschtItem deletedAttribute: item
Type: Item
Vertrag / Contract
CONTRACT_CREATEDVertrag angelegtContract createdAttribute: contract
Type: Contract
CONTRACT_ACTIVATEDVertrag aktiviertContract activatedAttribute: contract
Type: Contract
CONTRACT_CHANGEDVertrag geändertContract changedAttribute: contract
Type: Contract
CONTRACT_TERMINATEDVertrag gekündigtContract terminatedAttribute: contract
Type: Contract
CONTRACT_ENDEDVertrag beendet (Vertragsende erreicht)Contract ended (date of termination reached)Attribute: contract
Type: Contract
Rechnung / Invoice
INVOICE_CREATEDRechnung erstelltInvoice createdAttribute: invoice
Type: Invoice
INVOICE_PAYMENT_RECEIVEDRechnung: Zahlungseingang erhaltenInvoice: payment received

Attribute: invoice
Type: Invoice

Attribute: payDate
Type: date
(payment date)

Attribute: payAmount
Type: number
(amount paid)

INVOICECORRECTION_CREATEDRechnungskorrektur erstelltInvoice correction createdAttribute: invoicecorrection
Type: InvoiceCorrection
Mahnwesen / Dunning
DUNNING_CREATEDMahnung verschicktDunning sent

Attribute: invoice
Type: Invoice

Attribute: dunningLevel
Type: number
(new dunning level)

Bestellung / Order
ORDER_RECEIVEDBestellung erhaltenOrder receivedAttribute: orderCustomer
Type: OrderCustomer
Test
TESTHOOKTest-AufrufTest callAttribute: dummyData
Type: Dummy