Webhook

WebhookAnytime an event happens on your account, your application can be notified by Parallex Pay. This is where webhooks come in. This is useful for events that are not triggered by direct API request, but when the response from that request needs to be known (for instance, in cases when there is an update to a transaction status). It is necessary only for behind-the-scenes transactions. Parallex Pay's webhooks are HTTP calls that are triggered by specific events. Parallex Pay's webhooks replace regular API calls with instant, real-time notifications. It can be set up on your dashboard by specifying a URL we would send POST requests to you whenever an event that might be of interest happens. Each webhook notification contains an eventType that specifies which type of event triggered the webhook notification.To process notifications, you need to:

Expose an endpoint on an open server

We can send notifications as HTTP callbacks (webhooks) to an endpoint on a server that must be open. To receive webhooks, you must have a server that:

  • Has an endpoint that can receive JSON requests

  • Depending on your network and security requirements, you might also need to add our IP address to your firewall's whitelist.

Subscribe to webhook notifications

To configure webhook notifications:

  • Login to your dashboard.

  • Go to Settings > Webhook.

  • Enter your Notification URL

  • Enable Webhooks by turning on the Webhook switch

  • Click “Subscribe”

Accept the notifications

To ensure that your server is properly accepting notifications, we require you to acknowledge every notification with an HTTP 200 response code. If we don't receive this response within 10 seconds, for example because your server is down, all notifications to your endpoint will be queued and retried. For more information, refer to Queued notifications. When your server receives notification:

  1. 1.Save the notification in your database.

  2. 2.Acknowledge the notification with the following HTTP response status code 200.

  3. 3.Apply your business logic.

Make sure that you acknowledge the notification before applying any business logic, because a breakage in your business logic could otherwise prevent important updates from reaching your system.

Test and go live

You will be required to test your webhook notifications. Once you are satisfied that they are working according to requirements, you can go live.

Last updated