Skip to main content

Type Alias: ChatUnfurlArguments

type ChatUnfurlArguments: object & UnfurlTarget & TokenOverridable & object;

Type declaration

unfurls

unfurls: Logger;

Description

URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.

Type declaration

user_auth_blocks?

optional user_auth_blocks: (Logger | Logger)[];

Description

Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.

user_auth_message?

optional user_auth_message: string;

Description

Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.

user_auth_required?

optional user_auth_required: boolean;

Description

Set to true to indicate the user must install your Slack app to trigger unfurls for this domain. Defaults to false.

user_auth_url?

optional user_auth_url: string;

Description

Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

Defined in

packages/web-api/src/types/request/chat.ts:224