Remote Files

Similar to the local file API, Slack also offers a remote file API. We use this API to add and manipulate remote files.

Let’s look at the following endpoints in this lesson:

files.remote.add: This endpoint adds a file from a remote service.
files.remote.share: This endpoint shares a remote file into a channel.
files.remote.update: This endpoint updates an existing remote file.
files.remote.info: This endpoint retrieves information about a remote file added to Slack.
files.remote.list: This endpoint retrieves information about a remote file added to Slack.
files.remote.remove: This endpoint removes a remote file.

Add a remote file

To add a remote file, we access the https://slack.com/api/files.remote.add endpoint. With this endpoint, we’ll add a remote document. We must first add a remote file before sharing it in a chat. You can make a new Google document by going to this link: doc.new. Copy the shareable link of the Google document, and paste it into the coding widget below.

Note: If you are not a Google user, you can use any other remote file URL.

Press + to interact

import fetch from "node-fetch";
const url = new URL("https://slack.com/api/files.remote.add");
const headerParameters = {
  Authorization: "Bearer {{TOKEN}}",
  "Content-Type": "application/x-www-form-urlencoded",
};
const queryParameters = new URLSearchParams({
  external_id: generateId(),
  external_url: "{{DOC_1}}",
  title: "My first remote file",
});
const options = {
  method: "GET",
  headers: headerParameters,
};
async function addRemoteFile() {
  try {
    url.search = queryParameters;
    const response = await fetch(url, options);
    printResponse(response);
  } catch (error) {
    printError(error);
  }
}
addRemoteFile();

Parameter	Type	Category	Description
`token`	token	required	Authentication tokens carry the required scopes that govern the usage of different Slack applications and APIs. We usually pass these tokens as an HTTP Authorization header or as a POST parameter.
`channels`	string	required	This is a comma-separated list of channel IDs where the file will be shared.
`external_id`	string	optional	This is the GUID for the file, as set by the application registering the file with Slack. We require this field or `file`, or both.
`file`	string	optional	This specifies a file registered with Slack by providing its ID. This field, `external_id`, or both are required.

Press + to interact

import fetch from "node-fetch";
const url = new URL("https://slack.com/api/files.remote.share");
const headerParameters = {
  Authorization: "Bearer {{TOKEN}}",
  "Content-Type": "application/x-www-form-urlencoded",
};
const queryParameters = new URLSearchParams({
  channels: "{{CHANNEL_ID}}",
  file: "{{FILE_ID}}",
});
const options = {
  method: "GET",
  headers: headerParameters,
};
async function shareRemoteFile() {
  try {
    url.search = queryParameters;
    const response = await fetch(url, options);
    printResponse(response);
  } catch (error) {
    printError(error);
  }
}
shareRemoteFile();

Press + to interact

import fetch from "node-fetch";
const url = new URL("https://slack.com/api/files.remote.update");
const headerParameters = {
  Authorization: "Bearer {{TOKEN}}",
  "Content-Type": "application/x-www-form-urlencoded",
};
const queryParameters = new URLSearchParams({
  file: "{{FILE_ID}}",
  title: "Updated Title",
});
const options = {
  method: "GET",
  headers: headerParameters,
};
async function updateRemoteFile() {
  try {
    url.search = queryParameters;
    const response = await fetch(url, options);
    printResponse(response);
  } catch (error) {
    printError(error);
  }
}
updateRemoteFile();

Press + to interact

import fetch from "node-fetch";
const url = new URL("https://slack.com/api/files.remote.info");
const headerParameters = {
  Authorization: "Bearer {{TOKEN}}",
  "Content-Type": "application/x-www-form-urlencoded",
};
const queryParameters = new URLSearchParams({
  file: "{{FILE_ID}}",
});
const options = {
  method: "GET",
  headers: headerParameters,
};
async function getRemoteFileInfo() {
  try {
    url.search = queryParameters;
    const response = await fetch(url, options);
    printResponse(response);
  } catch (error) {
    printError(error);
  }
}
getRemoteFileInfo();

Parameter	Type	Category	Description
`token`	token	required	Authentication tokens carry the required scopes that govern the usage of different Slack applications and APIs. We usually pass these tokens as an HTTP Authorization header or as a POST parameter.
`channel`	string	optional	This filters files appearing in a specific channel, indicated by its ID.
`cursor`	string	optional	This parameter is a string of characters used to "point" to the next "page" of data. We paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`.
`limit`	integer	optional	This is the maximum number of items to return.

Press + to interact

import fetch from "node-fetch";
const url = new URL("https://slack.com/api/files.remote.remove");
const headerParameters = {
  Authorization: "Bearer {{TOKEN}}",
  "Content-Type": "application/x-www-form-urlencoded",
};
const queryParameters = new URLSearchParams({
  file: "{{FILE_ID}}",
});
const options = {
  method: "GET",
  headers: headerParameters,
};
async function removeRemoteFile() {
  try {
    url.search = queryParameters;
    const response = await fetch(url, options);
    printResponse(response);
  } catch (error) {
    printError(error);
  }
}
removeRemoteFile();

Introduction

Chat Using the Application

Conversations Using an App

File Management

Users

Manage Reactions

Slack's Bolt Framework

Conclusion

Appendix

Add a remote file

Share a remote file

Update a remote file

Get information about a remote file

List all remote files

Remove a remote file