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

# List webhooks

`GET /v1/webhooks`

## Request

- Base URL: `https://yourbaseurl.talon.one`
- URL: `https://yourbaseurl.talon.one/v1/webhooks`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/talon/apis/management-api/docs/v1/webhooks/get.ts> (a function with typed inputs; its response is checked against the schema)

> [!note] Management API endpoints are **not** meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List all webhooks.

## Query parameters

- `applicationIds` string
- `sort` string
- `pageSize` integer
- `skip` integer
- `creationType` 'templateWebhooks' | 'webhooks'
- `visibility` 'visible' | 'hidden'
- `outgoingIntegrationsTypeId` integer
- `title` string

## Response `200`

OK

- object
  - `totalResultSize` integer, required
  - `data` WebhookWithOutgoingIntegrationDetails[], required
    - `id` integer, required: The internal ID of this entity.
    - `created` string, date-time, required: The time this entity was created.
    - `modified` string, date-time, required: The time this entity was last modified.
    - `applicationIds` integer[], required: The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`.
    - `title` string, required: Name or title for this webhook.
    - `description` string: A description of the webhook.
    - `draft` boolean, required: Indicates if the webhook is a draft.
    - `verb` 'POST' | 'PUT' | 'GET' | 'DELETE' | 'PATCH', required: API method for this webhook.
    - `url` string, required: API URL (supports templating using parameters) for this webhook.
    - `headers` string[], required: List of API HTTP headers for this webhook.
    - `payload` string: API payload (supports templating using parameters) for this webhook.
    - `params` TemplateArgDef[], required: Array of template argument definitions.
      - `type` 'string' | 'boolean' | 'number' | 'time' | '(list string)' | '(list number)', required: The type of value this argument expects.
      - `description` string: A campaigner-friendly description of the argument, this will also be shown in the rule editor.
      - `title` string, required: A campaigner friendly name for the argument, this will be shown in the rule editor.
      - `ui` object, required: Arbitrary metadata that may be used to render an input for this argument.
      - `key` string: The identifier for the associated value within the JSON object.
      - `picklistID` integer: ID of the picklist linked to a template.
      - `restrictedByPicklist` boolean: Whether or not this attribute's value is restricted by picklist (`picklist` property)
    - `enabled` boolean, required: Enables or disables webhook from showing in the Rule Builder.
    - `authenticationId` integer: The ID of the credential that this webhook is using.
    - `outgoingIntegrationTemplateId` integer: Identifier of the outgoing integration template.
    - `outgoingIntegrationTypeId` integer: Identifier of the outgoing integration type.
    - `outgoingIntegrationTypeName` string: Name of the outgoing integration.

---

[API](https://skmtc.dev/talon/apis/management-api.md) - [All operations](https://skmtc.dev/talon/apis/management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talon/apis/management-api/revisions/7ef1b9504c3a?raw)