Delete Webhook Configuration

Overview

Permanently deletes a webhook configuration. This action cannot be undone. The webhook key will become available for reuse after deletion.

Command Details

• Command: DeleteWebHookConfigCommand
• Type: Command (write operation)

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
$type	string	Yes	Must be DeleteWebHookConfigCommand
id	long	Yes	The ID of the webhook configuration to delete

Try It Out

POST/api/bpm/cmdDeleteWebHookConfigCommand

Base URL

Bearer Token

Request Body

{ "cmd": "DeleteWebHookConfigCommand", "data": { "id": 201 } }

Response Structure

Success:

{
  "success": true,
  "data": {
    "id": 201,
    "key": "payment-notification",
    "deletedAt": "2026-03-09T16:00:00Z"
  },
  "message": "Webhook configuration deleted successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Deletion failed",
  "errors": [
    "Configuration not found"
  ]
}

Related Operations

• Create Config — Create a new webhook configuration
• Get Config List — List all configurations
• Deactivate Config — Deactivate instead of deleting