De-register Webhook

Deregistering a webhook via API involves removing a previously registered webhook configuration from the GrailPay. To disable notification related to particular transaction events, you need to de-register webhook with registered events name.

Once deregistered, the previously registered webhook will no longer be triggered by the GrailPay, and notifications will no longer be delivered to the configured endpoint.

Endpoint

DELETE /3p/api/v1/webhook

Request Payload

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

{ "data": { "h-0": "Fields", "h-1": "Type", "h-2": "Is Required", "h-3": "Description", "0-0": "**event_names**", "0-1": "string array", "0-2": "Yes", "0-3": "_Possible Values:_ \nTransactionStarted \nTransactionCaptureStarted \nTransactionCompleted \nTransactionFailed \nTransactionCanceled \nPayoutFailed \nPayoutCompleted \nClawbackStarted \nClawbackFailed \nClawbackCompleted \nBankLinkedSuccessfully \nBankLinkFailed \nBankAccountRemoved \nBusinessCreated \nBusinessUpdated \nBatchPayout (only by processor token) \nRefundPending \nRefundCaptureStarted \nRefundCaptureCompleted \nRefundCaptureFailed \nRefundPayoutPending \nRefundPayoutCompleted \nRefundPayoutFailed \nBatchRefund (only by processor token) \nReversePayoutStarted \nReversePayoutCompleted \nReversePayoutFailed \nMerchantBatchPayout", "1-0": "**webhook_url**", "1-1": "string array", "1-2": "No", "1-3": "" }, "cols": 4, "rows": 2, "align": [ "left", "left", "left", "left" ] }

Response Object

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

Errors & Warnings

Code	Message
401
422