Skip to content

Webhooks

Create a Webhook

Webhooks may be created by signing in to Close Connect, going to the API Details screen and adding the webhook URL under the Stage Change Webhook Url field.

Screenshot of Webhook creation UI

INFO

Only Https target Url's may be used for webhooks. Http url's will be ignored for security reasons.

Status Change Event

Sent when the pipeline stage/status of an application changes. An application from transition from any stage to any other stage - and may or may not follow a pre-defined linear progression of stages.

javascript
{
    "caseId": "B1951693544567",
    "previousStage": "open",
    "newStage": "submitted"
    "loanAmount": "15000",
    "monthlyPayment": "312",
    "rate": "14.75",
    "aprc": "16.2",
    "requirements": [
        "Proof of Residency",
        "Proof of Address",
        "Payslips",
        ...
    ]
}

Close Connect Documentation