List Webhook Configurations

Overview

Retrieves a paginated list of webhook configurations. Supports export to Excel when isExport is set to true.

Command Details

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

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
$type	string	Yes	Must be GetWebHookConfigListQuery
pageIndex	int	No	Page index, zero-based (default: 0)
pageSize	int	No	Items per page (default: 20)
isExport	bool	No	Set to true to export results as Excel (default: false)

Try It Out

POST/api/bpm/cmdGetWebHookConfigListQuery

Base URL

Bearer Token

Request Body

{ "cmd": "GetWebHookConfigListQuery", "data": { "pageIndex": 0, "pageSize": 20, "isExport": false } }

Response Structure

Success:

{
  "success": true,
  "data": {
    "items": [
      {
        "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"
      }
    ],
    "pageIndex": 0,
    "pageSize": 20,
    "totalCount": 1,
    "totalPages": 1
  },
  "message": "Webhook configurations retrieved successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Failed to retrieve configurations",
  "errors": [
    "Invalid filter parameters"
  ]
}

Related Operations

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