Webhooks

Webhook registration and event delivery

Webhook endpoints let partners register subscriptions, select event names, update the delivery URL, and trigger simulated events for testing.

Webhook routes

Method	Route	Input	Response
`POST`	`/api/Webhook/register`	`WebhookSubscription` plus `partnerId` or `customerId`	Empty success response
`POST`	`/api/Webhook/unregister`	`WebhookSubscription` plus `partnerId` or `customerId`	Empty success response
`POST`	`/api/Webhook/update-all`	`partnerId` or `customerId`	Empty success response
`GET`	`/api/Webhook/get-registered-webhooks`	`partnerId` or `customerId`	List of event names
`POST`	`/api/Webhook/update-webhook-uri`	`webhookUri` plus `partnerId` or `customerId`	Empty success response
`POST`	`/api/Webhook/generate-simulated-webhook`	`eventName` plus `partnerId` or `customerId`	Empty success response

Subscription object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhookUri": "https://partner.example.com/webhooks/plexe",
  "secret": "shared-secret",
  "isActive": true,
  "webhooks": [
    "WB_Customer_Created",
    "WB_Application_Created"
  ]
}

partnerId must be a valid GUID for partner subscriptions.

webhookUri should be a publicly reachable HTTPS endpoint.

webhooks can be omitted when using subscribe-all behavior.

Supported event names

WB_Partner_Request WB_Application_Created WB_Customer_Created WB_Customer_And_Application_Created WB_Application_Current_Process WB_Application_Status_Changed WB_Loan_Created WB_Bank_Transactions_Refresh WB_Communication_Sent WB_Loan_Withdrawal_Completed WB_Send_Secondary_Applicant_Notice WB_Under_Review WB_Send_Sms WB_Send_Otp WB_Send_Loan_Otp WB_Application_Cancelled WB_Send_Two_Factor_Code WB_Send_Application_Ready WB_Application_Ready WB_Loan_Enabled_Or_Disabled WB_Loan_Closed WB_Loan_Opened

Current limitations

The current read route returns event names only, not the saved webhook URI, masked secret, or last delivery status.

The portal therefore asks for partner ID manually and treats the webhook URL as write-focused setup data.

A future GET /api/Webhook/subscription route would make the partner admin experience more complete.