---
title: "Get webhooks by context or plan"
method: GET
path: "/v2/webhooks"
tags: ["Webhooks"]
---

# Get webhooks by context or plan

`GET /v2/webhooks`

Returns a list of webhooks corresponding to the context or plan provided, if they exist. For plan, the webhooks for all contexts that you have access to will be returned, and theresponse is paginated

## Query parameters

- `context` string
- `context_id` string
- `plan_api_id` string
- `cursor` string

## Response `200`

Response from the GET /v2/webhooks endpoint.

- object
  - `webhooks` WebhookV2[], required — An array of webhooks.
    - `id` string, required — The ID of the webhook
    - `event_type` 'PING' | 'FILE_UPDATE' | 'FILE_VERSION_UPDATE' | 'FILE_DELETE' | 'LIBRARY_PUBLISH' | 'FILE_COMMENT' | 'DEV_MODE_STATUS_UPDATE', required — An enum representing the possible events that a webhook can subscribe to
    - `team_id` string, required — The team id you are subscribed to for updates. This is deprecated, use context and context_id instead
    - `context` string, required — The type of context this webhook is attached to. The value will be "PROJECT", "TEAM", or "FILE"
    - `context_id` string, required — The ID of the context this webhook is attached to
    - `plan_api_id` string, required — The plan API ID of the team or organization where this webhook was created
    - `status` 'ACTIVE' | 'PAUSED', required — An enum representing the possible statuses you can set a webhook to: - `ACTIVE`: The webhook is healthy and receive all events - `PAUSED`: The webhook is paused and will not receive any events
    - `client_id` string, nullable, required — The client ID of the OAuth application that registered this webhook, if any
    - `passcode` string, required — The passcode that will be passed back to the webhook endpoint. For security, when using the GET endpoints, the value is an empty string
    - `endpoint` string, required — The endpoint that will be hit when the webhook is triggered
    - `description` string, nullable, required — 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.
  - `pagination` ResponsePagination — If pagination is needed due to the length of the response, identifies the next and previous pages.
    - `prev_page` string — A URL that calls the previous page of the response.
    - `next_page` string — A URL that calls the next page of the response.

## Other responses

- `400` — Bad request. Parameters are invalid or malformed. Please check the input formats. This error can also happen if the requested resources are too large to complete the request, which results in a timeout. Please reduce the number and size of objects requested.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.

## Changes

> 36 revisions in range; 33 could not be searched.

- **2023-12-14** `de5c0106668d` — 1 breaking
  - api removed without deprecation

[Change history](https://skmtc.dev/figma/apis/figma-api/changes/v2/webhooks/get.md)

---

[API](https://skmtc.dev/figma/apis/figma-api.md) · [All operations](https://skmtc.dev/figma/apis/figma-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/figma/figma-api/revisions/d7ab5681d84c/schema)