Notifications/Webhooks

For certain events, the Nitrobox can send a notification (via web hooks) to another system. Notifications must be activated and set up. Notifications are sent asynchronously. Notifications are used, for example, to pick up an invoice document that has just been generated and make it available to the customer, or to trigger further follow-up processes in a third party system (e.g. an e-commerce shop).

Available Notifications

notificationstatustechnical identifierdescription
Document createdinvoice.createdA document has been created in the system. This notification is independent of the (PDF) file creation and archiving, which run as an asynchronous process.
Document archivedinvoice.archivedA document has been stored in the file archive and can now be accessed via the file end point.
Document updatedinvoice.updatedAn already existing document was updated. This essentially refers to meta-information or the document status. In terms of content, documents are unchangeable.
Payment Intent Resultpaymentintent.resultAn Payment Intent was processed in conjunction with the stored Payment Service Provider.
Payment assignedpaymentAssignment.processedA payment has been assigned to a transaction. Payments can be assigned to a document or an order.
Payment assignment reversedpaymentAssignment.reversedAn assigned payment has been reversed. Payments can be assigned to a document or an order.
Contract createdcontract.createdA new contract (subscription) has been created.
Contract updatedcontract.updatedAn existing contract was updated.
Contract terminatedcontract.terminatedAn existing contract was terminated in a regular manner.
Contract canceledcontract.cancelledAn existing contract was terminated extraordinarily.
Contract renewedcontract.renewedAn existing contract has been extended by the term defined in the plan.
Customer createdcustomer.createdA new customer record has been created.
Customer updatedcustomer.updatedAn existing customer has been changed.
Address createdaddress.createdA new address record has been created for a customer.
Address updatedaddress.updatedAn existing address record for a customer has been changed.
Order createdorder.createdA new order has been created.
Order updatedorder.updatedAn existing order has been changed.
Order cancelledorder.cancelledAn existing order has been cancelled.

standard
upcoming release/on demand