Type Alias ConversationCreateEvent

Type declaration

• Optionalpayload?: {
      conversation?: ConversationTruncated;
      creationReason?:
          | "linkRequest"
          | "message"
          | "none"
          | "notification"
          | "prechatCapture"
          | "startConversation"
          | "proactiveMessaging";
      referral?: Referral
      | null;
      source?: SourceWithCampaignWebhook;
      user?: UserReadable | null;
  }

  The payload of the event. The contents of this object depend on the type of event.

  • Optionalconversation?: ConversationTruncated

    The conversation that was created.

  • OptionalcreationReason?:
        | "linkRequest"
        | "message"
        | "none"
        | "notification"
        | "prechatCapture"
        | "startConversation"
        | "proactiveMessaging"

    The reason why the conversation was created, if applicable.

    • linkRequest - The conversation was created in order to generate a link request to transfer the user to a different channel.
    • message - The conversation was created because a message was sent.
    • none - The conversation was not created for a specific purpose. Used primarily when a conversation is created via the Create Conversation API.
    • notification - The conversation was created by a call to the Notification API.
    • prechatCapture - The conversation was created because the user completed a prechat capture form in the Web Messenger.
    • startConversation - The conversation was created because of a call to the startConversation API on one of the SDK integrations, or a start conversation event was triggered from a messaging channel.
    • proactiveMessaging - The conversation was created because the user interacted with a campaign.

  • Optionalreferral?: Referral | null

    Referral information, if applicable.

  • Optionalsource?: SourceWithCampaignWebhook

    The source of the creation.

  • Optionaluser?: UserReadable | null

    The user associated with the conversation. Only present if the created conversation was of type personal. For sdkGroup conversations, the list of participants can be fetched using the List Participants API, if required.