Skip to main content
Webhooks are a way for your application to receive real-time notifications from Upfront about events that happen in your account. When an event occurs, Upfront sends an HTTP POST request to the URL you have configured for the webhook. You can see a list of configured webhooks and create new webhooks in the Webhooks page under Broker settings.

​
Events and payloads

Upfront sends webhooks for the following events and with the following payloads:

​
application.approved

This is triggered when an application has been approved and is ready to be accepted by the agent. 
{
  "brokerage_id": "string",
  "timestamp": "string",
  "event": "application.approved",
  "deal": {
    "id": "string",
    "link": "string",
    "offers": [
      {
        "id": "string",
        "link": "string",
        "amount": 0,
        "expiry_date_time": "string",
        "origination_fee_percent": 0,
        "percent_of_commission": 0,
        "created_at": "string"
      }
    ]
  },
  "identifiers": {
    "application_id": "string",
    "deal_id": "string"
  }
}

​
application.rejected

This is triggered when an application has been rejected. 
{
  "brokerage_id": "string",
  "timestamp": "string",
  "event": "APPLICATION_REJECTED",
  "deal": {
    "id": "string",
    "link": "string"
  },
  "rejection_reasons": [
    "string"
  ],
  "note": "string",
  "identifiers": {
    "application_id": "string",
    "deal_id": "string"
  }
}

​
invoice.paid

This is triggered when an invoice has been successfully paid by an agent. 
{
  "brokerage_id": "string",
  "timestamp": "string",
  "event": "INVOICE_PAID",
  "deal": {
    "id": "string",
    "link": "string"
  },
  "payment": {
    "id": "string",
    "amount": 0,
    "status": "PAID"
  },
  "identifiers": {
    "deal_id": "string",
    "payment_id": "string"
  }
}