Type Alias ClientRemoveEventWritable

Type declaration

• Optionalpayload?: {
      client?: Types.Client;
      conversation?: ConversationTruncated | null;
      error?: { [key: string]: unknown } | null;
      reason?: "api" | "linkCancelled" | "linkFailed" | "sdk" | "theft";
      source?: SourceWebhook;
      user?: UserTruncatedWritable;
  }

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

  • Optionalclient?: Types.Client

    The removed client.

  • Optionalconversation?: ConversationTruncated | null

    The conversation associated with the removal of the client. This field is only present when the reason is theft, linkCancelled or linkFailed. Note that for the theft reason, the conversation will not be present if it has been deleted.

  • Optionalerror?: { [key: string]: unknown } | null

    Object containing details of what went wrong. This field will only be present when the reason is linkCancelled or linkFailed.

  • Optionalreason?: "api" | "linkCancelled" | "linkFailed" | "sdk" | "theft"

    The reason for which the client was removed.

    • api - The client was removed using the API.
    • linkCancelled - The user cancelled a channel link.
    • linkFailed - The client was removed after a channel link attempt failed.
    • sdk - The client was removed using the SDK.
    • theft - The client was transferred to another user due to a channel link.

  • Optionalsource?: SourceWebhook

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

  • Optionaluser?: UserTruncatedWritable

    The user associated with the client.