Overview of the Figma provider and registering webhooks
team ID
. This is a unique identifier for your Figma team. Webhooks are created at the team level, so you/your users will need to provide this value when creating a webhook. We provide a helper function to retrieve the team ID
for you. See below.
SDK
is strongly typed and uses Classes
in the background to provide the easiest experience possible. Here’s how to create a webhook:
REST API
doesn’t support retrieving the team ID
programmatically. You will need this value to interact with the API. The team ID
can be found in the URL of your Figma team. Use our hook to redirect the user to obtain the teamID value.
callbackUrl
or eventType
. The resulting webhook will be under the same project and endpointID so you don’t need to worry about updating things in your database/storage.
figmaFileCommentEventExamplePayload
. Use intelligent auto-complete in your IDE to find the payload you need.
Here’s an example of the Figma File Comment Example Payload
(you can import as figmaFileCommentEventExamplePayload
):
any
type, now you can do something like this: