Skip to main content

@slack/web-api / ChatUnfurlArguments

Type Alias: ChatUnfurlArguments

type ChatUnfurlArguments = ChatUnfurlUnfurls | ChatUnfurlMetadata & UnfurlTarget & TokenOverridable & object;

Defined in: packages/web-api/src/types/request/chat.ts:313

Type Declaration​

user_auth_blocks?​

optional user_auth_blocks?: (KnownBlock | Block)[];

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.