HomeGuidesAPI ReferenceChangelog

Events

Supported events you can receive via Payitoff Webhooks

Supported Events

The following are the events you can receive, process, and react to in your applications via Payitoff Webhooks.

Event notifications delivered via Webhooks will provide the same shaped JSON payload containing event_type and data keys. All event types follow an object.event pattern, and where relevant, return a JSON representation of the object which experienced the event, with updated data reflecting the state of the object after the event—the shape of this object will match the documented shape in its relevant schema. Some events, such as the test event type, return null as their data.

NOTE: In the JSON samples below, the data object includes the Schema of the data that will be returned. Each event description should include a link to the relevant schema.


borrower.delinquent

An event that occurs when a Borrower is detected to have entered delinquency status at a Servicer.

{ 
  "event_type": "borrower.delinquent",
  "data": {
    "borrower": Borrower,
    "servicer": Servicer
  }
}

NOTE: This event cannot be triggered manually at this time.


connectivity.interrupted

An event that occurs when the account-syncing connectivity between a Borrower and a Servicer has been interrupted (e.g., because credentials have changed). The event notification will provide Borrower.uuid and Servicer.id values.

{ 
  "event_type": "connectivity.interrupted",
  "data": {
    "borrower_id": "29847388-7220-40a2-8596-2732ce167a34",
    "servicer_id": "ed9eeb2b-47bc-4b81-93a5-328b7a14c1b7"
  }
}

NOTE: This event can only be triggered manually via our Test Webhook URL API endpoint in our sandbox environment.


connectivity.restored

An event that occurs when the account-syncing connectivity between a Borrower and a Servicer has been restored (e.g., because user has re-authenticated). The event notification will provide Borrower.uuid and Servicer.id values.

{ 
  "event_type": "connectivity.restored",
  "data": {
    "borrower_id": "29847388-7220-40a2-8596-2732ce167a34",
    "servicer_id": "ed9eeb2b-47bc-4b81-93a5-328b7a14c1b7"
  }
}

NOTE: This event can only be triggered manually via our Test Webhook URL API endpoint in our sandbox environment.


connectivity.offline

An event that occurs when we detect a Servicer is in maintenance mode or has otherwise gone offline to an extent that affects all borrowers at that Servicer.

{ 
  "event_type": "connectivity.offline",
  "data": {
    "servicer": Servicer
  }
}

NOTE: This event cannot be triggered manually at this time.


connectivity.online

An event that occurs when we detect a Servicer is no longer in maintenance mode or services have been restored to an extent that no longer affects all borrowers at that Servicer.

{ 
  "event_type": "connectivity.online",
  "data": {
    "servicer": Servicer
  }
}

NOTE: This event cannot be triggered manually at this time.


enrollment.approved

An event that occurs when an Enrollment is known to be approved by a Servicer.

{ 
  "event_type": "enrollment.approved",
  "data": {
    "enrollment": Enrollment
  }
}

NOTE: This event can only be triggered manually via our Test Webhook URL API endpoint in our sandbox environment.


enrollment.needs_attention

An event that occurs when an Enrollment is known to have not been approved by a Servicer after a period of time.

{ 
  "event_type": "enrollment.needs_attention",
  "data": {
    "enrollment": Enrollment
  }
}

NOTE: This event can only be triggered manually via our Test Webhook URL API endpoint in our sandbox environment.


loan.paid_off

An event that occurs when a Loan held by a Borrower has been paid off.

{ 
  "event_type": "loan.paid_off",
  "data": {
    "borrower": Borrower,
    "loan": Loan
  }
}

NOTE: This event cannot be triggered manually at this time.


payment.historical_change

An event that occurs when a Payment has been detected as having changed in value since its original recording on behalf of a Borrower . This can occur when a Servicer corrects a data error and corrects historical data that was incorrectly recorded.

{ 
  "event_type": "payment.historical_change",
  "data": {
    "borrower": Borrower,
    "payment": Payment
  }
}

NOTE: This event cannot be triggered manually at this time.


refinance.initiated

An event that occurs when a Borrower has initiated a Loan Refinance.

{ 
  "event_type": "refinance.initiated",
  "data": {
    "borrower": Borrower
  }
}

NOTE: This event cannot be triggered manually at this time.


test

A generic test event that will be delivered with no additional data payload. It is intended to aid in verifying your webhook endpoint is working and responding correctly.

{ 
  "event_type": "test",
  "data": null
}

NOTE: This event can be triggered manually via our Test Webhook URL API endpoint in both our sandbox and production environments.



Did this page help you?