Figma · Schema

WebhookV2

A description of an HTTP webhook (from Figma back to your application)

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name	Type	Description
id	string	The ID of the webhook
team_id	string	The team id you are subscribed to for updates
client_id	['string', 'null']	The client ID of the OAuth application that registered this webhook, if any
passcode	string	The passcode that will be passed back to the webhook endpoint
endpoint	string	The endpoint that will be hit when the webhook is triggered
description	['string', 'null']	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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "WebhookV2",
  "type": "object",
  "description": "A description of an HTTP webhook (from Figma back to your application)",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the webhook"
    },
    "team_id": {
      "type": "string",
      "description": "The team id you are subscribed to for updates"
    },
    "client_id": {
      "type": "['string', 'null']",
      "description": "The client ID of the OAuth application that registered this webhook, if any"
    },
    "passcode": {
      "type": "string",
      "description": "The passcode that will be passed back to the webhook endpoint"
    },
    "endpoint": {
      "type": "string",
      "description": "The endpoint that will be hit when the webhook is triggered"
    },
    "description": {
      "type": "['string', 'null']",
      "description": "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."
    }
  }
}