Create Webhook
figma.create_webhook
ActionBusiness appsconnection required
Calls the Figma API with the connection's credentials.
Subscribe an HTTPS endpoint to one Figma event on a team, project or file. Figma sends a PING to the endpoint immediately unless the webhook is created paused.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Figma
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}, or {"personal_access_token": "figd_…"}
- Config it needs
- base_url, plan_api_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, 5 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
event_type The Figma event to subscribe to. | string | Yes | — | one of "PING", "FILE_UPDATE", "FILE_VERSION_UPDATE", "FILE_DELETE", "LIBRARY_PUBLISH", "FILE_COMMENT", "DEV_MODE_STATUS_UPDATE" | — |
context What the webhook watches: a whole team, one project, or one file. | string | Yes | — | one of "team", "project", "file" | — |
context_id The id of that team, project or file. | string | Yes | — | — | aBcDeF1234567890GhIjKl |
endpoint The HTTPS URL Figma will POST to. Max 2048 characters. | string | Yes | — | ≤ 2048 characters; url format | — |
passcode A value Figma echoes in every delivery so your endpoint can tell the call is genuine. Max 100 characters. | string | Yes | — | ≤ 100 characters | — |
status Create the webhook active, or paused so no PING is sent yet. | string | No | — | one of "ACTIVE", "PAUSED" | — |
description A name for the webhook, shown when listing them. Max 150 characters. | string | No | — | ≤ 150 characters | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"context_id": "aBcDeF1234567890GhIjKl"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The new webhook's id. | string | — |
event_type The event it fires on. | string | — |
context TEAM, PROJECT or FILE. | string | — |
context_id The id of the watched context. | string | — |
status ACTIVE or PAUSED. | string | — |
endpoint The URL Figma will call. | string | — |
plan_api_id The plan the webhook was created under. | string | — |
{
"context": "",
"context_id": "",
"endpoint": "",
"event_type": "",
"id": "",
"plan_api_id": "",
"status": ""
}See Create Webhook run in a workflow.
In a technical demo we add the Figma connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.