Party Web-Hooks

Explore the integration of web-hooks with our Party product, a feature designed to ensure you receive instant notifications and updates on parties; be that through direct Party activities or as part of our Payable or Receivable flows.

Web-hooks in Party offer a dynamic way to receive notifications about the activities, changes and statuses of your parties, 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 Party web-hooks, including the structure of the data payload and practical use-cases.

Events Triggering Web-Hooks for a Party

Web-hooks for Party are triggered and dispatched at various stages throughout the life cycle of a Payable, Receivable, or Party workflow. For each significant Party activity or change within the journey, a corresponding web-hook is sent. These events include:

  • Party Created

  • Party Updated

  • Party Status Change

  • Account Added

  • Verification Score

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 event, providing an overview of what occurred

  • statusId reflects the status ID of the Party at the time when event occurred, see Party event statuses table below

  • eventReferenceId links notification back to its corresponding entity, typically represented by PartyReferenceId, facilitating entity mapping

  • partyReferenceId the reference Id of the Party the event occurred with.

  • 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 error 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 or neutral, offering further context or helpful information specific to the successful outcome of an event