Skip to content

daniel-simpson/slack-emojinator

 
 

Repository files navigation

Slack Emojinator

Bulk upload emoji into Slack

Want to create a custom Slack emoji for every pokemon? Slack doesn't currently expose an API endpoint for creating emoji, probably to prevent users from doing exactly what I'm doing, but here's a way to do it anyway.

Creating Emoji

You'll need Python and pip to get started. I recommend using pipenv.

Prepare a directory that contains an image for each emoji you want to create. Remember to respect Slack's specifications for valid emoji images: no greater than 128px in width or height, no greater than 64K in image size. The base filename of each image file should be the name of the emoji (the bit you'll type inside : to display it).

Clone the project and install its prereqs:

libxml is required on your system, if you'd like to use the bulk export script.

git clone https://github.com/smashwilson/slack-emojinator.git
cd slack-emojinator
pipenv install

You'll need to provide your team name (the bit before ".slack.com" in your admin URL) and your session cookie (grab it from your browser). Copy .env.example, fill them in, and source it.

To grab your Slack session cookie:

  • Open your browser's dev tools and copy the value of document.cookie.
  • Go to the Network tab.
  • Re-load your workspace's Slack emoji customization page.
  • Find the call to emoji (it is most likely the very top request).
  • Scroll to Request-Headers, copy the value of "Cookie," and add to your .env file.

To grab your Slack API TOKEN:

  • Open your workspace's Slack emoji customization page.
  • Upload a single emoji with dev tools open
  • Look for a request header api_token
cp .env.example .env
${EDITOR} .env
source .env

Now you're ready to go. Use a shell glob to invoke upload.py with the emoji files as ARGV:

pipenv run python upload.py ${EMOJI_DIR}/*.png

Exporting Emoji

To export emoji, use export.py and specify an emoji directory:

source .env
pipenv run python export.py path-to-destination/

Using Docker

This project now includes a dockerfile, for anyone keen to run without installing python locally.

Build

To build the docker image locally:

docker build . -t slack-emojinator

Run

Upload Emoji

docker run -v <Emoji directory>:/emoji -e SLACK_TEAM=<SLACK TEAM NAME> -e SLACK_API_TOKEN="<SLACK API TOKEN>" -e SLACK_COOKIE="<SLACK COOKIE>" slack-emojinator

or

docker run -v <Emoji directory>:/emoji slack-emojinator upload.py /emoji --team-name="<SLACK TEAM NAME>" --api-token="<SLACK API TOKEN>" --cookie="<SLACK COOKIE>"

Export Emoji

docker run -v <Emoji directory>:/emoji -e SLACK_TEAM=<SLACK TEAM NAME> -e SLACK_API_TOKEN="<SLACK API TOKEN>" -e SLACK_COOKIE="<SLACK COOKIE>" slack-emojinator export.py /emoji/

List Emoji

docker run -v <Emoji directory>:/emoji -e SLACK_TEAM=<SLACK TEAM NAME> -e SLACK_API_TOKEN="<SLACK API TOKEN>" -e SLACK_COOKIE="<SLACK COOKIE>" slack-emojinator list.py /emoji/info.json

About

Bulk upload emoji into Slack

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.4%
  • Dockerfile 1.7%
  • Shell 0.9%