Webhooks

Webhooks let Rently notify you when something changes on its side, such as an application's status, so you don't have to keep polling the API.

Registering a webhook

Webhooks are not self-service yet. To register one, contact the Rently tech team with:

  • The environment: Test or Production (see Environments).
  • The HTTPS URL Rently should send events to.
  • The event types you want to receive (see Event types).

Rently confirms once the webhook is active. Contact the same team to change or remove it.

How webhooks work

  1. Something happens on Rently, e.g. Rently's team approves an application.
  2. Rently sends an HTTP POST request to your registered URL with a JSON body describing the event.
  3. Your endpoint responds with a 2xx status to acknowledge it.
POST https://your-domain.example.com/rently/webhooks
Content-Type: application/json

{
  "eventId": "ebcd1398-1a5d-4b7c-9aa2-77b93e9acfb8",
  "eventType": "ApplicationStatusChangeEvent",
  "data": {
    "id": "a3f935af-1ca7-409f-b7cb-530e2b2699a2",
    "previousStatus": "pending",
    "status": "approved"
  },
  "dataVersion": "1.0",
  "eventTime": "2026-10-08T12:22:08.8655257+00:00"
}

Event envelope

Every event has the same envelope; only data depends on the event type.

FieldMeaning
eventIdUnique id of the event. Use it to detect events you have already processed.
eventTypeWhat happened. Decides the shape of data. See Event types.
dataThe event's payload.
dataVersionVersion of the data schema for this event type, e.g. 1.0.
eventTimeWhen the event happened, in ISO 8601 with a UTC offset.

Handling events

  • Respond with 2xx quickly and do any heavy processing afterwards.
  • Use eventId to skip events you have already handled.
  • Ignore event types you don't recognise. New event types will be added over time.
  • Check dataVersion before reading data, so a future version of an event doesn't break your handler.
  • Treat the event as a notification. To get the full, current state, read the resource from the API, e.g. GET /v2/ae/rnpl/{productFlowId}.

Event types

Event typeSent when
ApplicationStatusChangeEventAn application's status changes.

More event types will be added in the future.

ApplicationStatusChangeEvent

Sent every time an application moves from one status to another, e.g. when Rently's team approves it, rejects it or asks for more documents.

{
  "eventId": "ebcd1398-1a5d-4b7c-9aa2-77b93e9acfb8",
  "eventType": "ApplicationStatusChangeEvent",
  "data": {
    "id": "a3f935af-1ca7-409f-b7cb-530e2b2699a2",
    "previousStatus": "pending",
    "status": "approved"
  },
  "dataVersion": "1.0",
  "eventTime": "2026-10-08T12:22:08.8655257+00:00"
}
FieldMeaning
data.idThe application id: the productFlowId returned when the application was created.
data.previousStatusThe status the application moved from.
data.statusThe status the application is in now.

For the possible statuses and what each one means, see The flow at a glance in the AE RNPL guide.