List Webhooks
figma.list_webhooks
ActionBusiness appsconnection required
Calls the Figma API with the connection's credentials.
List webhooks on one context, or every webhook on a plan. Figma refuses a plan id together with a context.
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
4 fields, none 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 |
|---|---|---|---|---|---|
context Narrow to one team, project or file. Requires context_id. | string | No | — | one of "team", "project", "file" | — |
context_id The id of that team, project or file. | string | Conditional | — | only with context | — |
plan_api_id List every webhook on this plan instead. Defaults to the connection's plan_api_id, and cannot be combined with a context. | string | No | — | — | 123456789012345678 |
cursor The paging cursor from a previous call's next_page. Only the plan listing is paginated. | string | No | — | — | — |
- At least one of plan_api_id, context_id must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"plan_api_id": "123456789012345678"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
webhooks The webhooks that matched. | array | — |
count How many webhooks this page carries. | number | — |
next_page URL of the next page, or empty when there is none. | string | — |
prev_page URL of the previous page, or empty. | string | — |
{
"count": 0,
"next_page": "",
"prev_page": "",
"webhooks": []
}See List Webhooks 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.