Payvala

Assistant

Payvala Assistant

Suggestions

Press Enter to send ยท Shift+Enter for new line

On this page

Webhooks Overview

Payvala webhooks allow your application to receive supported platform and transaction events asynchronously.

Instead of continuously polling the API for changes, your application can receive event notifications through a configured webhook endpoint.

Webhook processing should be implemented securely and should account for request verification, duplicate deliveries, retries, and event processing requirements.

Event Notifications

Receive supported Payvala platform and transaction events through your configured webhook endpoint.

Secure Verification

Verify incoming webhook requests before trusting or processing the received event data.

Reliable Processing

Design your webhook handler to safely process retries and duplicate event deliveries.

Configure Webhook Endpoint

Configure an application endpoint capable of receiving supported Payvala webhook events.

Your webhook endpoint should be securely exposed and capable of handling incoming event requests reliably.

Webhook Endpoint

Provide an application endpoint that can receive supported Payvala webhook events.

HTTPS

Use a secure HTTPS endpoint for receiving webhook requests.

Fast Response

Return an appropriate response promptly after receiving and validating a webhook request.

Reliable Availability

Keep the webhook endpoint available so supported events can be delivered successfully.

Webhook Events

Payvala can deliver supported platform or transaction events to your configured webhook endpoint.

Each event should be handled according to its documented event type and payload contract.

Your application should safely handle event types that are not currently recognized by the integration.

01

Receive the Event

Accept the webhook request from Payvala through your configured endpoint.

02

Identify the Event

Determine the event type and identify the event information provided in the request.

03

Validate the Payload

Validate the received payload before using the event data in your application.

04

Process the Event

Process the event according to the documented event behavior and your application's business logic.

Webhook Payload

Webhook requests contain event information that your application uses to identify and process the notification.

The exact event payload structure depends on the supported Payvala event and should be implemented according to the applicable webhook specification.

Event Information

Use the event information provided by Payvala to determine what occurred.

Transaction Information

Where applicable, process the transaction or reference information included with the event.

Payload Data

Process the event data according to the documented payload contract for the event type.

Verify Webhook Requests

Webhook requests must be verified according to the security mechanism defined for your Payvala integration before the event is trusted or processed.

01

Receive the Request

Receive the incoming webhook request through your configured HTTPS endpoint.

02

Validate Verification Data

Validate the request using the webhook verification mechanism specified by Payvala.

03

Reject Invalid Requests

Do not process webhook data when the required verification checks fail.

04

Process Verified Events

Continue with event processing only after the webhook request has passed the required verification checks.

Process Webhook Events

A webhook handler should separate request verification, payload validation, duplicate detection, and business processing.

01

Verify the Request

Verify the incoming webhook request before trusting its contents.

02

Validate the Event

Validate the event type and payload according to the applicable event contract.

03

Check for Duplicates

Check whether the event has already been processed before performing business operations.

04

Process the Event

Execute the required application logic for the verified event.

05

Return Success

Return the appropriate successful response after the webhook has been accepted for processing.

Delivery & Retries

Webhook delivery can require retry handling when an event cannot be successfully delivered or processed.

Your application should be designed to handle repeated delivery of the same event without causing unintended duplicate business operations.

Delivery Failure

Handle webhook delivery failures safely and ensure the endpoint can recover from temporary problems.

Retry Handling

Design the webhook handler to safely receive events that may be delivered again.

Fast Acknowledgement

Acknowledge valid webhook requests promptly and avoid keeping the delivery request open unnecessarily.

Failure Monitoring

Monitor repeated webhook delivery or processing failures so integration issues can be investigated.

Idempotency & Duplicate Events

Webhook consumers should be idempotent because the same event may be delivered more than once.

Use the event information available in the webhook payload to prevent repeated processing from creating unintended business results.

Track Processed Events

Store an appropriate event identifier or reference after successfully processing an event.

Detect Duplicate Delivery

Check whether an incoming event has already been processed before executing business operations.

Avoid Duplicate Operations

Ensure repeated delivery does not create duplicate transactions, records, notifications, or other business actions.

Keep Processing Safe

Design event handlers so that retries and repeated requests can be handled without corrupting application state.

Testing Webhooks

Test webhook handling in the appropriate non-production environment before enabling or relying on webhook processing in Production.

Testing should cover successful delivery, verification failures, duplicate events, and application-side processing failures.

01

Configure a Test Endpoint

Configure an endpoint in the appropriate test environment for receiving webhook events.

02

Test Event Reception

Verify that your application can receive and correctly identify supported webhook events.

03

Test Verification

Verify that valid webhook requests are accepted and invalid verification attempts are rejected.

04

Test Duplicate Handling

Verify that receiving the same event more than once does not create unintended duplicate processing.

05

Test Failure Handling

Validate application behavior when webhook processing or downstream business logic fails.

Webhook Troubleshooting

Use the checks below when webhook events are not received, verified, or processed as expected.

Webhook Not Received

Check endpoint availability, network access, configuration, and application logs.

Verification Failed

Check that the webhook verification implementation matches the mechanism defined for your integration.

Invalid Payload

Validate the received payload against the documented event contract.

Duplicate Event

Check your event tracking and idempotency logic to ensure repeated delivery is handled safely.

Processing Failure

Review application logs and event-processing logic for failures after successful webhook reception.

Delivery Timeout

Ensure your webhook endpoint can validate and acknowledge requests promptly.

Security Best Practices

Follow these practices when implementing and operating Payvala webhook integrations.

Use HTTPS

Use a secure HTTPS endpoint for receiving webhook requests.

Verify Every Event

Verify every incoming webhook request before trusting or processing the event.

Protect Sensitive Data

Do not expose sensitive webhook data, credentials, or security information through public resources.

Protect Logs

Avoid logging sensitive information unnecessarily and protect application and monitoring logs.

Use Idempotent Processing

Design webhook processing so repeated delivery does not create unintended duplicate operations.

Monitor Failures

Monitor repeated delivery and processing failures to identify integration problems quickly.

Secure. Reliable. Scalable.

Payvala is built with enterprise-grade security, 99.9% uptime, and scalable infrastructure.

Authentication
Versioning