Skip to main content

WebhookEvent

Events a platform partner can subscribe a webhook to. When the event occurs, the registered URL receives a POST with a payload identifying the affected offer, policy, rework or pre-registration.

enum WebhookEvent {
  OFFER_CREATED
  OFFER_UPDATED
  REWORK_CREATED
  REWORK_UPDATED
  POLICY_ISSUED
  POLICY_PICKED_UP
  PRE_REGISTRATION_CREATED
}

Values​

WebhookEvent.OFFER_CREATED​

An offer has been created for a broker in your tree (including offers created directly in the insurance system, not only via this API).

WebhookEvent.OFFER_UPDATED​

An offer in your tree has changed status, signature, or application state.

WebhookEvent.REWORK_CREATED​

A rework has been opened on an offer/policy in your tree.

WebhookEvent.REWORK_UPDATED​

An existing rework changed status (e.g. resolved/closed) or details.

WebhookEvent.POLICY_ISSUED​

A policy has been issued for an offer/application in your tree.

WebhookEvent.POLICY_PICKED_UP​

A customer has confirmed digital pickup of a policy in your current broker tree. The payload contains contractID and the confirmed ISO pickedUpAt timestamp. Registration, inbox confirmation and document downloads alone do not trigger this event. Requires the POLICY_READ permission at registration and delivery. Delivery is best effort and may repeat; reconcile current status through Policy.pickedUpAt.

WebhookEvent.PRE_REGISTRATION_CREATED​

A Vermittler in your tree has added a Vormerkung, or a customer has completed their own Altersvorsorgedepot pre-registration after accepting that Vermittler's registration link. Broker-prepared records and invitations trigger this event in Partner Life and through createPreRegistration, but not when an invitation is claimed. Customer-created records trigger it on completion, not on incomplete saves or later corrections to a completed record. The payload contains only the entry ID, kind and responsible broker ID. The preRegistrations query also lists incomplete and independently started customer records attributed to the tree; these do not trigger this webhook. Poll the query to discover them and subsequent changes. Requires PRE_REGISTRATION_READ at registration and delivery. Delivery is best effort and may repeat; use the entry ID to handle duplicate notifications.

Member Of​

RegisterWebhookInput input ● UnregisterWebhookInput input ● Webhook object