Webhooks API

Overview

The Webhooks API provides operations for configuring and managing webhook endpoints and dynamic routing. It supports both fixed integration endpoints (for services like Mono and Remita) and a powerful dynamic webhook router that can dispatch incoming payloads to native commands, BPMN processes, or inline scripts.

Available Commands

#	Command	Type	Description
1	CreateWebHookConfigCommand	Command	Create a new webhook configuration
2	ActivateWebHookConfigCommand	Command	Activate a webhook configuration
3	DeactivateWebHookConfigCommand	Command	Deactivate a webhook configuration
4	UpdateWebHookConfigCommand	Command	Update an existing webhook configuration
5	DeleteWebHookConfigCommand	Command	Delete a webhook configuration
6	GetWebHookConfigListQuery	Query	List webhook configurations with pagination
7	GetWebHookConfigByIdQuery	Query	Get a single webhook configuration by ID
8	LookupWebHookByKeyCommand	Command	Look up a webhook configuration by its key

Dynamic Webhook Router

Common Request Pattern

All commands and queries are sent as a POST to the unified BPM endpoint:

POST /api/bpm/cmd
Content-Type: application/json
Authorization: Bearer {token}

Request body:

{
  "$type": "CommandOrQueryClassName",
  // ...command-specific fields
}

Common Response Pattern

Success:

{
  "success": true,
  "data": { },
  "message": "Operation completed successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Description of what went wrong",
  "errors": ["Detailed error 1", "Detailed error 2"]
}

Authentication

All Webhooks API requests require a valid Bearer token in the Authorization header. Tokens are obtained via the authentication endpoint and must belong to a user with the appropriate webhook management permissions.

Execution Types

Value	Name	Description
0	ExecuteNativeCommand	Invoke a registered BPM command by name
1	ExecuteCommandChain	Run a sequence of commands
2	ExecuteCode	Execute an inline script
3	StartProcess	Start a BPMN process definition

Fixed Endpoints

The system also provides several fixed webhook endpoints for specific third-party integrations:

Endpoint	Description
/api/webhooks/mono/callback	Mono bank connection callback
/api/webhooks/remita	Remita payment notification webhook
/api/webhooks/remita/collection-notification	Remita collection debit notification

Quick Links

• Create Config — Create a new webhook configuration
• Activate Config — Activate a configuration
• Deactivate Config — Deactivate a configuration
• Update Config — Update an existing configuration
• Delete Config — Delete a configuration
• List Configs — List all configurations
• Get Config by ID — Get a configuration by ID
• Lookup by Key — Look up a configuration by key