Skip to main content
POST
Register a new webhook subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1
Available options:
loan.ingested,
loan.qc.passed,
loan.qc.failed,
loan.qc.exception,
loan.updated,
loan.repurchase.demanded,
pool.created,
pool.finalized,
pool.stratification.complete,
pool.constraint.violated,
deal.created,
deal.structured,
deal.priced,
deal.closed,
deal.amended,
deal.called,
ioi.received,
subscription.submitted,
subscription.confirmed,
allocation.finalized,
report.generated,
report.alm.ready,
report.exception.flagged,
remittance.received,
performance.updated,
delinquency.threshold.breached,
modification.reported,
partner.loan.forwarded,
partner.loan.accepted,
partner.loan.rejected,
partner.loan.securitized,
document.uploaded,
document.signed,
document.expired,
user.created,
user.deactivated,
api_key.rotated,
api_key.revoked
secret
string
Minimum string length: 16
description
string
Maximum string length: 255
active
boolean
default:true
headers
object

Response

Webhook subscription created