The Flow object

An invitation, task, or user request (e.g. join organization).

  • id

    string

    The system-assigned identifier of the flow.

  • state

    enum

    The current state of the flow.

    Possible values:
    START_PENDINGSTARTEDCOMPLETEDCANCELEDEXPIRED
  • stateReason

    string

    The code that best describes the reason for the state.

  • type

    enum

    The flow type.

    Possible values:
    JOIN_ORGANIZATIONSIGNUP
  • organization

    Organization

    The target organization for the flow.

  • user

    User

    The target user for the flow.

  • creator

    User

    The user who created the flow.

  • expireTime

    date-time

    The time the flow will expire.

  • createTime

    date-time

    The creation time of the flow.

  • joinOrganization

    JoinOrganizationFlow

    The join organization flow type specific data.

  • signup

    SignupFlow

    The signup flow type specific data.

PreviousFlows
NextList flows

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & Custom Auth