/chat.unfurl

POST

/chat.unfurl

Provide custom unfurl behavior for user-posted URLs

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://slack.com/api/chat.unfurl' \
--header 'token;' \
--data-urlencode 'channel=' \
--data-urlencode 'ts='

Response Example

200 - response

{
    "ok": true
}

Request

Header Params

token

string

required

Authentication token. Requires scope: links:write

Body Params application/x-www-form-urlencoded

channel

string

required

Channel ID of the message

string

required

Timestamp of the message to add unfurl behavior to.

unfurls

string

optional

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

user_auth_message

string

optional

Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior

user_auth_required

string

optional

Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain

user_auth_url

string

optional

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

Responses

🟢200Typical, minimal success response

application/json

Body

Schema for successful response from chat.unfurl method

enum<boolean>

required

Allowed value:

true

🔴500Typical error response

Modified at 2023-08-15 05:39:45

/chat.scheduleMessage

/chat.update