Receivables Web-Hooks

Explore the integration of web-hooks with our Receivables product, a feature designed to ensure you receive instant notifications and updates on payment statuses.

Web-hooks in Receivables offer a dynamic way to receive notifications about the status of your payments, directly integrating with your systems to provide timely updates.

With the implementation of OAuth 2.0 authentication, we ensure that each notification sent through our web-hooks is secure and reliable.

Here we will outline the basic functionalities offered by Receivables web-hooks, including the structure of the data payload and practical use-cases.

Events Triggering Web-Hooks for a Receivable

Web-hooks are triggered and dispatched at various stages throughout the life cycle of a Receivable. For each significant status update within the Receivable's journey, a corresponding web-hook is sent. These events include:

• Creation of a Receivable

• Initiation of a Receivable

• Scheduling of a Receivable

• Completion of a Receivable

• Updates to a Receivable

• Cancellation of a Receivable

• Failure of a Receivable

Web-Hooks Structure

The architecture of our web-hook payload is designed to cover both positive and negative scenarios. While the overall payload structure remains consistent across scenarios, the specific sections populated within the payload vary depending on the nature of the event.

Regardless of the event type, the web-hook payload includes several key components designed to offer a clear and actionable overview of the event:

• message is a general description of the error, providing an overview of what went wrong

• statusId reflects the status ID of the Receivable at the time when error occurred

• eventReferenceId links notification back to its corresponding entity, typically represented by receivable record number, facilitating entity mapping

• eventTimeStamp records exact date and time of the event, providing a temporal context for the notification

• correlationId serves as a distinct marker for the event, crucial for tracking and reference

• errorsAndNotices encapsulates any relevant errors and notifications associated with the event

• errorFound is a Boolean indicator for the presence

• errors, an array that is filled with error details if any are found during the event, outlining specific problems for quick identification and resolution

• notices, an array filled with messages for positive events, offering further context or helpful information specific to the successful outcome of an event