Create Webhook Configuration

Overview

Creates a new webhook configuration for the dynamic webhook router. Each configuration defines a unique key that serves as the webhook endpoint identifier, a path for the incoming URL, and specifies how incoming payloads should be processed via one of four execution types.

Command Details

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

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
$type	string	Yes	Must be CreateWebHookConfigCommand
key	string	Yes	Unique key used as the webhook endpoint identifier
description	string	Yes	Description of the webhook purpose
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

info

Provide exactly one of commandName, processDefinitionId, or executionCode depending on the selected executionType.

Try It Out

POST/api/bpm/cmdCreateWebHookConfigCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CreateWebHookConfigCommand", "data": { "key": "payment-notification", "description": "Handle incoming payment notifications from NIBSS", "isEnabled": true, "path": "/webhooks/nibss/payment", "action": "POST", "executionType": 0, "commandName": "ProcessNibssPaymentNotificationCommand", "allowableIPs": "196.46.20.0/24" } }

Response Structure

Success:

{
  "success": true,
  "data": {
    "id": 201,
    "key": "payment-notification",
    "description": "Handle incoming payment notifications from NIBSS",
    "isEnabled": true,
    "path": "/webhooks/nibss/payment",
    "action": "POST",
    "executionType": 0,
    "commandName": "ProcessNibssPaymentNotificationCommand",
    "createdAt": "2026-03-09T10:30:00Z"
  },
  "message": "Webhook configuration created successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Validation failed",
  "errors": [
    "Key is required",
    "A webhook configuration with this key already exists"
  ]
}

Related Operations

• Update Config — Update this configuration
• Activate Config — Activate a configuration
• Get Config List — List all configurations