---
title: "Get webhooks"
method: GET
path: "/webhooks"
tags: ["Webhooks"]
---

# Get webhooks

`GET /webhooks`

Use this endpoint to retrieve the list of webhooks available for the specified user.

## Headers

- `x-oneflow-api-token` string, required
- `x-oneflow-user-email` string, email

## Response `200`

Returns the list of webhooks.

- object — A list of webhooks for given user.
  - `_links` object — Links to related endpoints.
    - `comments` object
      - `href` string, nullable
    - `contracts` object
      - `href` string, nullable
    - `contract` object
      - `href` string, nullable
    - `create` object
      - `href` string, nullable
    - `data_field` object
      - `href` string, nullable
    - `data_fields` object
      - `href` string, nullable
    - `events` object
      - `href` string, nullable
    - `event` object
      - `href` string, nullable
    - `files` object
      - `href` string, nullable
    - `file` object
      - `href` string, nullable
    - `next` object
      - `href` string, nullable
    - `parties` object
      - `href` string, nullable
    - `party` object
      - `href` string, nullable
    - `previous` object
      - `href` string, nullable
    - `publish` object
      - `href` string, nullable
    - `self` object
      - `href` string, nullable
    - `template_types` object
      - `href` string, nullable
    - `template_type` object
      - `href` string, nullable
    - `template` object
      - `href` string, nullable
    - `templates` object
      - `href` string, nullable
    - `workspaces` object
      - `href` string, nullable
    - `workspace` object
      - `href` string, nullable
    - `playbooks` object
      - `href` string, nullable
  - `count` integer, required
  - `data` object[], required
    - `callback_url` string, nullable, required — The webhook's callback url.
    - `configuration` object — Webhook configuration
      - `enable_draft_events` boolean — True if receiving webhooks for draft events
    - `filters` object[], nullable, required — An array of filters associated with the webhook.
      - `filter_rules` union[], required
        - union
          - object — This represents an event type filter rule which can be associated with a webhook filter.
            - `type` 'EVENT_TYPE', required — The type of the rule.
            - `values` string[], required — The types of events we want.
          - object — This represents a workspace filter rule which can be associated with a webhook filter.
            - `type` 'WORKSPACE', required — The type of the rule.
            - `values` integer[], required — The workspace IDs we want events for.
          - object — This represents an integration blueprint filter rule which can be associated with a webhook filter.
            - `type` 'BLUEPRINT', required — The type of the rule.
            - `values` integer[], required — The integration blueprint IDs we want events for.
    - `integration_instance` integer, nullable, required — Connected integration instance.
    - `integration_process_id` integer, nullable, required — This is a feature for the future, and the default value is `null`.
    - `legacy_webhook` boolean, required — True if the webhook is a legacy webhook.
    - `template_group_id` integer, nullable, required
    - `webhook_id` integer, required — webhook ID

## Other responses

- `400` — Invalid format or content of the request.
- `401` — The API token or the user email is invalid.
- `403` — The request is not authorized by the server.

---

[API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)