​
Onboarding events

EventDescription
onboarding.invitedTriggered when an applicant is invited for onboarding to worth customer.
onboarding.invite_acceptedTriggered when an applicant accepts the invitation.
onboarding.invite_completedTriggered when an integration completes the invitation flow / onboarding
onboarding.invite_expiredTriggered when an invitation is expired

​
onboarding.invited | onboarding.invite_accepted | onboarding.invite_completed | onboarding.invite_expired

Below payload is dispatched whenever an onboarding invitation is sent, accepted, completed or expired.

{

  "event_type": "onboarding.invited | onboarding.invite_accepted | onboarding.invite_completed | onboarding.invite_expired",

  "payload": {

    "business_applicants": [

      {

        "email": "xyz@email.com",

        "first_name": "XYZ",

        "last_name": "ABC"

      }

    ],

    "business_id": "2f2616ae-d695-42c8-ba94-da023abee546",

    "business_name": "XYZ LTD.",

    "case_id": "bbde8bb6-316f-4121-ac77-f17c35a0e8ea",

    "create_business": "true | false",

    "is_no_login": "true | false",

    "status": "INVITED | ACCEPTED | COMPLETED | EXPIRED",

  }

}

Was this page helpful?

IntegrationRisk