figma-discord-webhook

KO | EN

gitlite — search

#python #hacktoberfest #react #go #golang #rust #deep-learning #docker #java #windows #cli #kubernetes #vue #ios

figma-discord-webhook

(★ 10)

Send Figma publish events to a Discord webhook using Cloudflare Workers

figma-discord-webhook 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Deploy](https://github.com/bryanberger/figma-discord-webhook/actions/workflows/deploy.yml/badge.svg)](https://github.com/bryanberger/figma-discord-webhook/actions/workflows/deploy.yml)
## Overview

> **Note**: `LIBRARY_UPDATE` events from Figma seem bugged (webhooks are beta btw), they stream in 1 after the other, and would require some batch request handling to limit the amount of noise sent to Discord — for now they are just relayed through.

Cloudflare Worker listening to `LIBRARY_UPDATE` and `FILE_VERSION_UPDATE` events from Figma and sends them to a Discord channel webhook.

A webhook request is sent to this worker as soon as one of the Figma files listed in the KV is published.
If the correct payload is received, and validated (proper passcode, event, and file_key) then a Discord message is crafted and sent to the webhook url of your choice (per file_key).

> **Note**: Don't want an event to be sent to Discord? In Figma include `#exclude` in your commit description and it will be ignored.

![demo](https://raw.githubusercontent.com/bryanberger/figma-discord-webhook/master/.github/demo.png)

## Setup Figma Webhook

To add this webhook you must have `Admin` permissions over the team in which the file you want to track lives. Replace the variables below with real ones and send the curl request.

**Note:** You must be listed as a team admin even if you have Organization admin permissions ([see here](https://forum.figma.com/t/403-access-denied-trying-to-use-the-webhook-api/7638)).

### Add Webhook

```
curl -X POST -H 'X-FIGMA-TOKEN: <personal access token>' -H "Content-Type: application/json" 'https://api.figma.com/v2/webhooks' -d '{"event_type":"LIBRARY_PUBLISH","team_id":"YOUR_TEAM_ID","endpoint":"YOUR_ENDPOINT_URL","passcode":"YOUR_PASSCODE","description":"Design System Library Publish Events"}'
```

### Get All Webhooks for team

```
curl -H 'X-FIGMA-TOKEN: <personal access token>' 'https://api.figma.com/v2/teams/:team_id/webhooks'
```

### Delete Webhook

```
curl -X DELETE -H 'X-FIGMA-TOKEN: <personal access token>' 'https://api.figma.com/v2/webhooks/:webhook_id'
```

## Development

Local dev with wrangler

### 1. Add the KV namespace `FIGMA_DISCORD_WEBHOOK` via wrangler

Add file_key / Discord webhook key-value pairs to it via the web UI or via wrangler

```
wrangler kv:namespace create --preview "FIGMA_DISCORD_WEBHOOK"
wrangler kv:key put --binding="FIGMA_DISCORD_WEBHOOK" "FILE_KEY_HERE" "FULL_DISCORD_WEBHOOK_URL_HERE"
```

### 2. Add Secrets

Add your Figma Webhook passcode

```
wrangler secret put FIGMA_PASSCODE
```

### 3. Run Locally

```
wrangler dev
```

## Publish

Publish to Cloudflare Workers

```
wrangler publish
```

figma-discord-webhook

figma-discord-webhook 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

figma-discord-webhook

figma-discord-webhook 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README