Guides

Events Overview

Suggest Edits

We use Webhooks to notify you of key PayTo events such that you can keep your platform up to date and enable the best user experience for your customers.

Our Webhooks are HTTP callbacks containing a simple payload that describes the key attributes of the event that has occurred.

Our Webhooks are designed to be real-time, triggering as soon as events occur on the NPP, enabling your platform to deliver real-time user experiences for both your customers and your back office.

Common Payload Attributes

To help you manage the receipt of our notifications, each Webhook includes the following attributes:

  1. EventID - This is our unique event identifier. This value does not change when we attempt to resend the same event.
  2. EventType - The type of the event represented as 'Resource.Status'.
  3. PublishedAt - This timestamp helps you understand when we sent this event to you.
  4. Payload - Key event details are included in the payload.
  5. NPPPublishedAt - This timestamp helps you understand when this event took place in the NPP network, regardless of when it was delivered.
  6. SchemaVersion - All of our Webhooks are currently on version 1.0.0. This may change in the future.

Backout Retry Mechanism

To ensure that our notifications are successfully received by your platform, we have implemented a standard practice backout retry mechanism. This mechanism attempts to redeliver the Webhook in case of an HTTP 4XX or 5XX delivery error.

  1. Retry immediate re-delivery,
  2. Retry delivery in 30 seconds,
  3. Retry delivery in 10 minutes,
  4. Retry delivery in 1 hour,
  5. Retry delivery in 2 hours,
  6. Retry delivery in 1 day.

📘

Delivery confirmation

Successful delivery is determined by receipt of an HTTP 2XX response.

Updated 6 months ago