Register a Webhook

Registering a webhook via API call involves configuring a client application to receive notifications and updates from GrailPay. To enable notification related to transaction, you need to register webhook with sets of predefined Events.

Once registered, the webhook will be triggered by the GrailPay whenever a relevant event occurs, such as a transaction started, completed or failed. The webhook will then send a notification to the configured endpoint, which can be processed by the client application to perform additional actions or update relevant data.

📘

Authentication Route

This route is secured with processor or vendor token authentication.

Endpoint

Request Payload

{
    "webhook_url": [
      "https://example.com/webhook/transaction"
    ],
    "event_names": [
      "TransactionCompleted",
      "TransactionFailed"
    ]
}

Response Object

{
    "status": true,
    "message": "Webhook registered successfully!",
    "data": null,
    "errors": []
}

Errors & Warnings