Deactivate Webhook Configuration

Overview

Deactivates a webhook configuration, preventing it from processing incoming webhook requests. The configuration can be reactivated later without losing its settings.

Command Details

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

API Endpoint

POST /api/bpm/cmd

Request Structure

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

Try It Out

POST/api/bpm/cmdDeactivateWebHookConfigCommand

Base URL

Bearer Token

Request Body

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

Response Structure

Success:

{
  "success": true,
  "data": {
    "id": 201,
    "key": "payment-notification",
    "isEnabled": false,
    "deactivatedAt": "2026-03-09T12:00:00Z"
  },
  "message": "Webhook configuration deactivated successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Deactivation failed",
  "errors": [
    "Configuration not found",
    "Configuration is already inactive"
  ]
}

Related Operations

• Activate Config — Reactivate the configuration
• Get Config by ID — Get details of a specific configuration
• Get Config List — List all configurations