Register a webhook endpoint
Registers a URL on your server that O.J. will send events to. The response includes the signing secret for
this endpoint. It is shown once, so store it. Deliveries follow the Standard Webhooks specification, are
retried with increasing delays for up to 72 hours if your server does not respond, and can be replayed from
GET /events.
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.
255Body
Omit to receive every event.
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
Endpoint registered
A URL on your server that O.J. sends events to. event_types limits which events are sent; leave it empty to receive all of them. secret is the key used to sign each delivery and is returned only when the endpoint is created, so store it then.
"whe_01K5X3Y1G5"
enabled, disabled "webhook_endpoint"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 Returned once, on creation. whsec_…

