zendesk-messaging-client
    Preparing search index...

    Type Alias ConversationMessageDeliveryPayloadWritable

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

    type ConversationMessageDeliveryPayloadWritable = {
        conversation?: ConversationTruncated;
        destination?: { integrationId?: string; type?: string };
        externalMessages?: { id?: string }[] | null;
        isFinalEvent?: boolean;
        message?: { id?: string };
        user?: UserWritable;
    }
    Index

    Properties

    conversation? destination? externalMessages? isFinalEvent? message? user?

    Properties

    conversation?: ConversationTruncated

    The conversation in which the message was sent.

    destination?: { integrationId?: string; type?: string }

    A nested object representing the destination of the message.

    Type declaration

    • OptionalintegrationId?: string

      Identifier indicating which integration the message was sent to.

    • Optionaltype?: string

      An identifier for the channel to which a message was sent to. May include one of "web", "ios", "android", "messenger", "viber", "telegram", "wechat", "line", "twilio", "api", "notification", or any other channel.

    externalMessages?: { id?: string }[] | null

    An array of objects representing the third-party messages associated with the event. The order of the external messages is not guaranteed to be the same across the different triggers. Note that some channels don’t expose message IDs, in which case this field will be unset.

    Type declaration

    • { id?: string }[]
      • Optionalid?: string

        A string representing the ID of the external message.

    • null
    isFinalEvent?: boolean

    A boolean indicating whether the webhook is the final one for the message.id and destination.type pair.

    message?: { id?: string }

    The message that was sent.

    Type declaration

    • Optionalid?: string

      A string representing the ID of the message.

    user?: UserWritable

    The user associated with the conversation.

    Settings

    Member Visibility

    On This Page

    Properties