Get Webhook Configuration by ID

Overview

Retrieves a single webhook configuration by its unique ID. Returns the full configuration details including execution type settings and enabled status.

Command Details

• Command: GetWebHookConfigByIdQuery
• Type: Query (read operation)

API Endpoint

POST /api/bpm/cmd

Request Structure

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

Try It Out

POST/api/bpm/cmdGetWebHookConfigByIdQuery

Base URL

Bearer Token

Request Body

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

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",
    "allowableIPs": "196.46.20.0/24",
    "createdAt": "2026-03-09T10:30:00Z",
    "updatedAt": "2026-03-09T15:00:00Z"
  },
  "message": "Webhook configuration retrieved successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Configuration not found",
  "errors": [
    "No webhook configuration found with the specified ID"
  ]
}

Related Operations

• Get Config List — List all webhook configurations
• Update Config — Update this configuration
• Activate Config — Activate this configuration
• Deactivate Config — Deactivate this configuration