Types

There are a number of different properties associated with a webhook events. The following contains all of the properties webhook events will have:

Name	Properties
WebhookV2 A description of an HTTP webhook (from Figma back to your application).	idNumber The id of the webhook. event_typeWebhookV2Event The event this webhook triggers on. contextString The type of context this webhook is attached to, as a string enum. PROJECT TEAM FILE context_idString The ID of the context this webhook is attached to. team_idString The team id you are subscribed to for updates. If the webhook is subscribed to a file or project, this value is an empty string. plan_api_idString The plan API ID of the team or organization where this webhook was created. statusWebhookV2Status The current status of the webhook. client_idString The client ID of the OAuth application that registered this webhook, if any. passcodeString The passcode that will be passed back to the webhook endpoint. For security, when using the GET endpoints, the value is an empty string. endpointString The endpoint that will be hit when the webhook is triggered. descriptionString Optional user-provided description or name for the webhook. This is provided to help make maintaining a number of webhooks more convenient. Max length 140 characters.
WebhookV2Request Information regarding the most recent interactions sent to a webhook endpoint.	webhook_idNumber The ID of the webhook the requests were sent to. request_infoWebhookV2RequestInfo Information regarding the request sent to the webhook endpoint. response_info0 Information regarding the response sent back from the webhook endpoint. null if no response was received. error_msgString | null Error message for this request. null if no error occurred.
WebhookV2RequestInfo Information regarding the request sent to the webhook endpoint.	endpointString The actual endpoint the request was sent to. payloadPayload The contents of the request that was sent to the endpoint. sent_atString UTC ISO 8601 timestamp of when the request was sent.
WebhookV2ResponseInfo Information regarding the reply sent back from a webhook endpoint.	statusString HTTP status code of the response. received_atString The UTC ISO 8601 time when the response was received.
WebhookV2Event An enum representing the possible events that a webhook can subscribe to.	A webhook can subscribe to all events listed in the Events section except the PING event.
WebhookV2Status An enum representing the possible statuses you can set a webhook to.	ACTIVE: The webhook is healthy and receives all events. PAUSED: The webhook is paused and will not receive any events.
LibraryItemData An object representing the library item information in the payload of the LIBRARY_PUBLISH event.	keyString Unique identifier of library item. nameString Name of library item.
CommentFragment An object representing a fragment of a comment left by a user, used in the payload of the FILE_COMMENT event. Note only ONE of the fields below will be set.	textString Comment text that is set if a fragment is text based. mentionString User id that is set if a fragment refers to a user mention.