Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface ShortLinkActivatedEvent

    Object reflecting an event that is created when a contact visits a shortlink. Currently, this is only supported for the Messenger and Instagram channels. See Shortlink Activated Event for more details.

    interface ShortLinkActivatedEvent {
        existing_thread?: boolean;
        payload?: string;
        ref?: string;
        source?: string;
        title?: string;
        type?: string;
    }
    Index

    Properties

    existing_thread? payload? ref? source? title? type?

    Properties

    existing_thread?: boolean

    Set to true if target channel's conversation thread already existed at the moment the shortlink was visited. Set to false if a new conversation thread began when the shortlink was visited.

    payload?: string

    Refers to the payload previously configured to be sent in the postback.

    ref?: string

    The ref parameter from the shortlink the user visited.

    source?: string

    Defaults to "SHORTLINK" for this type of event.

    title?: string

    Only relevant for the Instagram channel.

    type?: string

    The identifier for the referral. For Instagram and Messenger shortlinks, this is always set to "OPEN_THREAD".

    Settings

    Member Visibility

    On This Page

    Properties