provider Webhooks POST /v2/webhooks
@utdk/figma /v2/webhooks
Create a webhook
Create a new webhook which will call the specified endpoint when the event triggers. By default, this webhook will automatically send a PING event to the endpoint when it is created. If this behavior is not desired, you can create the webhook and set the status to PAUSED and reactivate it later.

Try it

Authentication
Configure credentials for Figma API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postwebhook
POST/v2/webhooks
Create a new webhook which will call the specified endpoint when the event triggers. By default, this webhook will automatically send a PING event to the endpoint when it is created. If this behavior is not desired, you can create the webhook and set the status to PAUSED and reactivate it later.

Input

required

An enum representing the possible events that a webhook can subscribe to

Team id to receive updates about. This is deprecated, use 'context' and 'context_id' instead.

required

Context to create the webhook for. Must be "team", "project", or "file".

required

The id of the context you want to receive updates about.

required

The HTTP endpoint that will receive a POST request when the event triggers. Max length 2048 characters.

required

String that will be passed back to your webhook endpoint to verify that it is being called by Figma. Max length 100 characters.

An enum representing the possible statuses you can set a webhook to: - `ACTIVE`: The webhook is healthy and receive all events - `PAUSED`: The webhook is paused and will not receive any events

User provided description or name for the webhook. Max length 150 characters.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import figma from '@utdk/figma';

await figma.postwebhook()