Chat

Chat Unfurl

POST
/chat.unfurl

Provide custom unfurl behavior for user-posted URLs

Authorization

slackAuth links:write
AuthorizationBearer <token>

In: header

Scope: links:write

Header Parameters

token*string

Authentication token. Requires scope: links:write

Content-Type*"application/x-www-form-urlencoded"

Value in

  • "application/x-www-form-urlencoded"

Request Body

application/x-www-form-urlencoded

channel*string

Channel ID of the message

ts*string

Timestamp of the message to add unfurl behavior to.

unfurls?string

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

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?boolean

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

user_auth_url?string

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

Response Body

application/json

application/json

curl -X POST "https://example.com/chat.unfurl" \  -H "token: string" \  -H "Content-Type: application/x-www-form-urlencoded" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'channel=string&ts=string'
{  "ok": "True"}