Page tree
Skip to end of metadata
Go to start of metadata

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.

Event Types

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

Event TypeBeschreibung DEDescription ENSchema
(payload)
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
ORDER_PROCESSEDBestellung: Kunde angelegtOrder: Customer created

Attribute: orderCustomer
Type: OrderCustomer

Attribute: customer
Type: Customer
(created customer)

ORDER_CANCELLEDBestellung storniertOrder cancelledAttribute: orderCustomer
Type: OrderCustomer
Test
TESTHOOKTest-AufrufTest callAttribute: dummyData
Type: Dummy

Example JSON

Each Webhook consists of the following fields:

  • eventType: event type (see above)
  • triggerDate: date at which the event occured
  • retryCount: number of already occured retries
  • payLoad: the data attributes (see above)


Example JSON: CUSTOMER_CREATED
{
   "eventType":"CUSTOMER_CREATED",
   "triggerDate":"2019-05-22T10:52:15",
   "retryCount":0,
   "payload":{
      "customer":{
         "salutation":"MR",
         "firstName":"Holger",
         "lastName":"Tester",
         "companyName":null,
         "locale":"de_DE",
         "websiteUri":null,
         "phone1":null,
         "phone2":null,
         "telefax":null,
         "mobile":null,
         "email":"mail@example.net",
         "birthdate":null,
         "euTaxId":null,
         "taxNumber":null,
         "noteText":null,
         "postalAddress":null,
         "billingAddress":{
            "addressLine1":"Teststraße 1",
            "addressLine2":null,
            "addressLine3":null,
            "zipCode":"12345",
            "cityName":"Testhausen",
            "state":null,
            "country":"DE"
         },
         "customerNumber":"K1234",
         "taxRegion":"NATIONAL",
         "duePeriod":0,
         "dueUnit":"DAY",
         "paymentMethod":"BANKTRANSFER",
         "emailInvoice":null
      }
   }
}
  • No labels