Figma icon

Figma

Use the Figma API

Webhook V2 → Get Webhook

AI-generated

Summary

Retrieve detailed information about a specific Figma webhook using its webhook ID, optionally including additional query parameters to tailor the response.

Inputs

  • Webhook ID (required) — Identifier of the webhook to retrieve.
  • Query Parameters — Optional collection of query parameters to customize the response, such as pagination cursors, event filters, and time bounds.

Output shape

A single JSON object representing the webhook data and its configuration as returned from the Figma API.

The operation requires a valid Webhook ID and OAuth2 credentials. Query parameters are optional and may filter or extend the data returned. If the webhook does not exist, an error may be returned.

Examples

Example 1: Fetch webhook by ID without additional parameters

Provide the Webhook ID and leave query parameters empty to retrieve the default webhook details.

Discussion