Details are provided in this section on setting up your Webhook Endpoint and listening for events via the Nuapay User Interface

Overview Setup

To set up Webhooks you will need to:

  1. Create an endpoint.
  2. Configure the Webhook(s) you require.
  3. Listen for events (see the Receiving Endpoint section for more on this).

Note that before you can use Webhooks you must set up a dedicated Endpoint on your infrastructure. (See Webhook Receiving Endpoint for more on this).

Setting up a Webhook

To set up a Webhook you must have Nuapay Console / Developer Dashboard access:

  1. Log on to the Nuapay Console.
  2. Click Webhooks from the left-hand menu and click Add Webhook.
  3. Add the required details in the pop-up dialog box:
  4. Specify:
    1. The name of the Webhook notification.
    2. The URL of the Endpoint you configured.
    3. Status is set to Enabled by default (if Disabled no notifications are generated).
    4. Retry period (determines for how many days failed notifications will be retried. Retries are automatically generated every 30 minutes). In the screen above the setting is 1 day so retries will be made every 30 minutes for 24 hours (or until a retry is successful).
    5. Sign Key is the secret key that the application uses to sign the notification JSON body. The signature is sent in the request HTTP 'x-signature' header. If you leave this field blank the application will automatically generate a key.
    6. The Event Types drop-down allows you to configure what events will trigger the notification to the Webhooks Endpoint URL. In the example above only Payment Received will trigger a notification but you may define 1-n events as required.
  5. Click Submit.

Once you have set up the Webhook, you will need to configure a Receiving Endpoint.