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.
Servers
- https://api.figma.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
context_id |
String | Yes |
The id of the context you want to receive updates about. |
context |
String | Yes |
Context to create the webhook for. Must be "team", "project", or "file". |
passcode |
String | Yes |
String that will be passed back to your webhook endpoint to verify that it is being called by Figma. Max length 100 characters. |
team_id |
String | No |
Team id to receive updates about. This is deprecated, use 'context' and 'context_id' instead. |
description |
String | No |
User provided description or name for the webhook. Max length 150 characters. |
event_type |
String | Yes |
An enum representing the possible events that a webhook can subscribe to Valid values:
|
status |
String | No |
State of the webhook, including any error state it may be in Valid values:
|
endpoint |
String | Yes |
The HTTP endpoint that will receive a POST request when the event triggers. Max length 2048 characters. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.