Get Webhook
figma.get_webhook
ActionBusiness appsconnection required
Calls the Figma API with the connection's credentials.
Read one webhook by id. Figma blanks the passcode on reads, so it comes back as an empty string.
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
1 field, 1 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 |
|---|---|---|---|---|---|
webhook_id The id of the webhook, as returned by figma.create_webhook or figma.list_webhooks. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The 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 calls. | string | — |
description The webhook's name, when it has one. | string | — |
{
"context": "",
"context_id": "",
"description": "",
"endpoint": "",
"event_type": "",
"id": "",
"status": ""
}See Get 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.