Lookup Webhook by Key

Overview

Looks up a webhook configuration by its unique key. This is the same lookup mechanism used by the dynamic webhook router when an incoming request arrives — it resolves the key to determine which configuration should handle the payload. Returns all configurations if key is empty.

Command Details

• Command: LookupWebHookByKeyCommand
• Type: Command (read operation)

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
$type	string	Yes	Must be LookupWebHookByKeyCommand
key	string	No	The unique key of the webhook configuration to look up (returns all if empty)

Try It Out

POST/api/bpm/cmdLookupWebHookByKeyCommand

Base URL

Bearer Token

Request Body

{ "cmd": "LookupWebHookByKeyCommand", "data": { "key": "payment-notification" } }

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 found"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Lookup failed",
  "errors": [
    "No webhook configuration found with the specified key"
  ]
}

Related Operations

• Create Config — Create a new webhook configuration
• Get Config by ID — Get a configuration by ID
• Get Config List — List all webhook configurations