Skip to content

Webhooks

Target Audience: Users, Developers

Introduction

This section describes the "Webhooks" functionality available within Payway.

Note: This functionality may also be known as Events or Service Bus Events.

Where can I find my webhooks?

In order to find your configured webhooks, simply navigate to PAP => Control panel => Webhooks.

How do I enable / disable a specific webhook?

This functionality is currently experimental, and is as such readonly. If you would like to update any of your webhooks, please reach out to our support, and we'll be glad to help out!

For future updates regarding making these changes yourselves, make sure to follow our changelog.

How do I check the status between Payway and my webhook?

In order to check the health of the connection between Payway and your registered webhook(s), simply navigate to PAP => Control panel => Webhooks, and select the endpoint you're interested in checking out.

Within this view, you will be able to find the endpoint status, as well as how many queued and/or failing events are currently trying to find their way to your endpoint.

Email notifications when an endpoint is failing

When an event endpoint starts failing, Payway will notify the administrators who hold the Superuser role/permission within your organisation via email, so that the issue can be looked into before events are lost.

Notifications are tied to two thresholds:

  • Soft limit — a warning threshold. The endpoint keeps retrying and remains active, but it has accumulated enough failing events to warrant attention. A single email is sent when this limit is reached.
  • Hard limit — the endpoint has kept failing beyond the soft limit and is now disabled, meaning events are no longer being delivered to it. A single email is sent when this limit is reached.

Note

The email is sent once per endpoint and per limit — not once per event type. In other words, regardless of how many different event types are configured on a failing endpoint, you will receive a single notification when the soft limit is reached, and a single notification when the hard limit is reached.

If you receive one of these emails, navigate to PAP => Control panel => Webhooks and select the affected endpoint to review its status and latest error message. If the endpoint has been disabled after reaching the hard limit, please reach out to our support and we'll be glad to help you get it re-enabled.