Skip to main content

Activate Webhook Configuration

Overview​

Activates a webhook configuration, enabling it to receive and process incoming webhook requests. Only active configurations will respond to incoming payloads routed through the dynamic webhook router.

Command Details​

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

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
$typestringYesMust be ActivateWebHookConfigCommand
idlongYesThe ID of the webhook configuration to activate

Try It Out​

POST/api/bpm/cmdActivateWebHookConfigCommand
Request Body

Response Structure​

Success:

{
"success": true,
"data": {
"id": 201,
"key": "payment-notification",
"isEnabled": true,
"activatedAt": "2026-03-09T11:00:00Z"
},
"message": "Webhook configuration activated successfully"
}

Error:

{
"success": false,
"data": null,
"message": "Activation failed",
"errors": [
"Configuration not found",
"Configuration is already active"
]
}