Register a webhook for one referral
Registers a URL that receives events for this referral only. Account-level endpoints receive everything. A per-referral webhook is for an agent or a serverless function that is working one deal and wants to be called back, with its own token, when that deal moves.
token is a value you choose. O.J. sends it back in the OJ-Webhook-Token header so you can check that
the call is for the right task. signing picks HMAC (the Standard Webhooks headers, the default) or JWT.
With JWT, each delivery carries Authorization: Bearer <jwt>, signed with a key published at
/.well-known/jwks.json, with iss, aud (your URL), iat, exp, jti and referral_id claims. The
webhook is removed when the referral reaches a final status, or at expires_at if that is sooner.
Authorizations
One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token.
Headers
IETF Idempotency-Key semantics (draft-ietf-httpapi-idempotency-key-header). Send a fresh unique value
(a UUID) with every new request. A retry with the same key and the same payload returns the original
response with the header Idempotent-Replayed: true. The same key with a different payload is rejected with
422 and code idempotency_key_reused. Keys are kept for 24 hours.
255Path Parameters
"ref_01K5X3K7Q2"
Body
Returned to you in the OJ-Webhook-Token header on every delivery.
hmac, jwt Omit to receive every event for the referral.
The kinds of events O.J. sends. The name is object.what_happened. The Webhooks section of the docs explains when each one fires.
referral.received, referral.matches_updated, referral.needs_partner, referral.needs_borrower, message.sent, message.received, referral.reminder_due, submission.awaiting_review, submission.decided, document_request.opened, document_request.satisfied, referral.submitted, offer.received, offer.accepted, referral.funded, referral.declined, referral.closed, payout.updated Response
Webhook registered
A webhook that receives events for one referral only. It is removed automatically when the referral reaches a final status.
"rwh_01K5X8C3D4"
hmac, jwt enabled, disabled, expired "referral_webhook"For hmac. Returned once, on creation.
The kinds of events O.J. sends. The name is object.what_happened. The Webhooks section of the docs explains when each one fires.
referral.received, referral.matches_updated, referral.needs_partner, referral.needs_borrower, message.sent, message.received, referral.reminder_due, submission.awaiting_review, submission.decided, document_request.opened, document_request.satisfied, referral.submitted, offer.received, offer.accepted, referral.funded, referral.declined, referral.closed, payout.updated 
