PUT /v2/webhooks/{webhook_id}
Update a webhook by ID.
Servers
- https://api.figma.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
webhook_id |
String | Yes |
ID of webhook to update |
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 |
|---|---|---|---|
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. |
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.