Type Alias ClientAddEventReadable

Type declaration

• Optionalpayload?: {
      client?: Types.Client;
      conversation?: ConversationTruncated | null;
      reason?: "channelLinking" | "sdkLogin" | "authCode";
      source?: SourceWebhook;
      user?: UserTruncatedReadable;
  }

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

  • Optionalclient?: Types.Client

    The client that was just created.

  • Optionalconversation?: ConversationTruncated | null

    The conversation associated with the creation of the client. This field is only present when the reason is channelLinking and when attaching the client to a specific conversation.

  • Optionalreason?: "channelLinking" | "sdkLogin" | "authCode"

    The reason for which the client was added.

    • channelLinking - The client was created as a result of initiating a channel link.
    • sdkLogin - The client was created as a result of logging into an SDK device.
    • authCode - The client was created as a result of initializing an SDK client with an authCode.

  • Optionalsource?: SourceWebhook

    The source where this event originated from. This could be the API or an SDK device.

  • Optionaluser?: UserTruncatedReadable

    The user associated with the client.