Webhooks

All webhooks events are sent via a POST request with the following payloads:

An offering is created:

{
    "event": "offering.created",
    "data": {
        "offering": {
            "Id": "1234",
            "Name": "Sample Offering",
            "Date_Published": "2024-06-01",
            "Summary": "<p>This is a sample offering summary.</p>",
            "Collateral": [
                {
                    "Id": "4567",
                    "Name": "My loan",
                    "Amount": 1000.23
                }
            ],
            "Risks": [
                "Risk 1",
                "Risk 2"
            ]
        }
    }
}

An existing offering is updated:

{
    "event": "offering.updated",
    "data": {
        "offering": {
            "Id": "1234",
            "Name": "Sample Offering",
            "Date_Published": "2024-06-01",
            "Summary": "<p>This is a sample offering summary.</p>",
            "Collateral": [
                {
                    "Id": "4567",
                    "Name": "My loan",
                    "Amount": 1000.23
                }
            ],
            "Risks": [
                "Risk 1",
                "Risk 2"
            ]
        }
    }
}

An offering is published:

{
    "event": "offering.published",
    "data": {
        "offering": {
            "Id": "1234",
            "Name": "Sample Offering",
            "Date_Published": "2024-06-01",
            "Summary": "<p>This is a sample offering summary.</p>",
            "Collateral": [
                {
                    "Id": "4567",
                    "Name": "My loan",
                    "Amount": 1000.23
                }
            ],
            "Risks": [
                "Risk 1",
                "Risk 2"
            ]
        }
    }
}