Event Updates Webhook

BN will send realtime update webhooks for the events happening in the Session

We'll post session update events to your webhook URL whenever the session progresses to next stage or has an update.

Method: Post. Supported auths: Bearer or Basic Auth.

{
    notarization_id: "",
    bn_session_id: "",
    event_type: "",
    event_details: {
        message: "",
        final_output_files: [
            {
                name: "",
                base64Doc: ""
            },
            {
                name: "",
                base64Doc: ""
            }
        ],
        additional_signers_signing_urls: {
            bn_signing_url: "",
            full_signing_url: ""
        }
    },
    event_by_details: {
        first_name: "",
        last_name: "",
        middle_name: "",
        name: "",
        email: ""
    }
}

event_type, can be one of the following:

- open_call_accepted : Triggered when notary picks up session
- photo_id_passed : Triggered when signer passes photoid stage
- photo_id_failed : Triggered when signer fails photoid stage
- biometrics_passed : Triggered when signer passes biometrics
- kba_started : Triggered when signer starts KBA flow
- kba_answered : Triggered when signer answers the KBA Flow Question Set
- kba_succeeded : Triggered when signer passes the KBA Stage
- kba_first_set_failed : Triggered when signer failes the first stage of KBA Question Set
- kba_failed : Triggered when signer fails KBA stage
- join_session : Triggered when any user joins session
- leave_session : Triggered when any user leaves session
- session_started : Triggered when session is started
- session_completed_clicked: Triggered when user completes the session, and document processing starts
- session_completed : Triggered when session is completed. This webhook request also sends the final signed pdf files
- session_expired : Triggered when session is expired. Once session is expired, the login links will not work.
- additional_signer_invited: Triggered when customer/notary invites an additional signer in session
- esign_action_completed: Triggered when a signer have signed the document for esign session
- personal_details_filled: Triggered when a new customer joins via vendor link and starts a new session. In this event under `event_details` section, additional keys like customer_email, customer_name, sessionId and state would be added
 

In case of event esign_action_completed the signer information can be retrieved from data available in event_by_details field. i.e email and name of the signer who have signed the document.