Update Webhook Configuration

Overview

Updates an existing webhook configuration. The key field is immutable and cannot be changed after creation — use id to identify the configuration to update. All other fields can be modified.

Command Details

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

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
$type	string	Yes	Must be UpdateWebHookConfigCommand
id	long	Yes	The ID of the webhook configuration to update
description	string	Yes	Updated description
isEnabled	bool	Yes	Whether the configuration is enabled
path	string	Yes	The URL path for this webhook
action	string	Yes	HTTP method (e.g., POST, GET)
executionType	int	Yes	0=ExecuteNativeCommand, 1=ExecuteCommandChain, 2=ExecuteCode, 3=StartProcess
executionCode	string	Conditional	Inline script (required if executionType is 2)
processDefinitionId	long	Conditional	BPMN process ID (required if executionType is 3)
commandName	string	Conditional	BPM command name (required if executionType is 0)
allowableIPs	string	No	Comma-separated list of allowed IP addresses or CIDR ranges

Try It Out

POST/api/bpm/cmdUpdateWebHookConfigCommand

Base URL

Bearer Token

Request Body

{ "cmd": "UpdateWebHookConfigCommand", "data": { "id": 201, "description": "Updated payment notification handler", "isEnabled": true, "path": "/webhooks/nibss/payment-v2", "action": "POST", "executionType": 0, "commandName": "ProcessNibssPaymentNotificationCommand", "allowableIPs": "196.46.20.0/24,10.0.0.0/8" } }

Response Structure

Success:

{
  "success": true,
  "data": {
    "id": 201,
    "key": "payment-notification",
    "description": "Updated payment notification handler",
    "isEnabled": true,
    "path": "/webhooks/nibss/payment-v2",
    "action": "POST",
    "executionType": 0,
    "commandName": "ProcessNibssPaymentNotificationCommand",
    "updatedAt": "2026-03-09T15:00:00Z"
  },
  "message": "Webhook configuration updated successfully"
}

Error:

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

Related Operations

• Create Config — Create a new webhook configuration
• Get Config by ID — Get details of this configuration
• Delete Config — Delete a configuration