API Reference

Webhooks

Webhooks are one way that apps can send automated messages or information to other apps.

Webhooks are automated messages sent from apps when something happens.
They have a message or payload and are sent to a unique URL essentially the app's phone number or address.

Once onboarding is completed, a webhook is sent to the app to notify them about it.

Sample for Approved :

{
	"entity": "lead_status",
	"payload": {
		"loan_ac_no": "{{loan_request.original_request_data.loan_account_number}}",
		"status": "Approved",
		"lead_id": "{{lead.partner_loan_id}}"
	},
	"event": "lead.status_update",
	"id": "<webhook id>",
	"created_at": "<2021 - 09 - 24T19:03: 51.565955 + 05: 30>"
}

Sample for Rejected :

{
	"entity": "lead_status",
	"payload": {
		"loan_ac_no": "{{loan_request}}",
		"status": "Rejected",
		"lead_id": "{{lead.uuid}}",
		"rejection_reason": "Rejected."
	},
	"event": "{{lead.status_update}}",
	"id": "<webhook id>",
	"created_at": "<2021 - 09 - 24 T19: 03: 51.565955 + 05: 30>"
}