> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# List webhook listeners

GET https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners

Returns every webhook listener in your organization as a JSON array. Unset fields come back as empty values, and secrets come back redacted.

Reference: https://docs.moveworks.com/api-reference/configuration-api/tool-studio/webhook-listeners/list-webhook-listeners

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Response

### 200

The webhook listeners in your organization

- `list of WebhookListenerConfig`

## Errors

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### WebhookListenerConfig

A webhook listener: an endpoint that receives incoming webhook requests from an external system, verifies them, and turns them into events.

- `id` (string, optional) — Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
- `display_name` (string, optional) — A readable name for the listener. 3 to 64 characters.
- `url_uuids` (list of string, optional) — Identifiers used to build the listener's public webhook URL. Generated by the server on create and cannot be changed.
- `signature` (FunctionSignatureSettings, optional) — The technical name and description that identify this listener.
- `reject_processing_dsl` (string, optional) — Moveworks DSL rule that acts as a kill switch. When true, the request is not processed. Evaluated against request_body, headers and query_params.
- `log_redaction_enabled` (boolean, optional) — If true, possibly sensitive data is redacted from this listener's logs.
- `security` (SecuritySettings, optional) — How the listener endpoint is secured, such as Moveworks authentication and an IP allowlist.
- `verification` (VerificationSettings, optional) — Request-level checks, such as signature verification, run on each incoming request.
- `payload` (PayloadSettings, optional) — How the request payload is parsed, validated and mapped into an event.
- `debounce` (DebounceSettings, optional) — Settings that collapse a burst of duplicate requests into a single event.
- `challenge` (ChallengeSettings, optional) — Settings for answering one-time verification (CRC) challenge requests from the external system.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

### FunctionSignatureSettings

- `name` (string, optional) — Technical name used to reference this function. Must start with a letter and contain only letters, digits and underscores; 2 to 64 characters.
- `description` (string, optional) — Description of what this function does. 12 to 1024 characters.
- `arguments` (list of ArgumentSettings, optional) — Input arguments the function accepts.
- `result_schema` (FunctionSignatureSettingsResultSchema, optional) — JSON schema describing the function's output.
- `display_name` (string, optional) — Human-readable name of the function. 2 to 64 characters. If empty, name is shown instead.

### SecuritySettings

- `moveworks_auth_enabled` (boolean, optional) — If true, requests to the endpoint must use Moveworks authentication.
- `ip_allowlist` (IPAllowlistSettings, optional) — IP addresses and ranges allowed to call the endpoint.

### VerificationSettings

- `validations` (list of ValidationSettings, optional) — Checks that every incoming request must pass. Up to 5.

### PayloadSettings

- `content` (ContentSettings, optional) — The expected content type of the request and the schema to validate it against.
- `mapper_bender` (PayloadSettingsMapperBender, optional) — Optional Moveworks data mapping that builds the event payload from the request. If unset, the request data itself becomes the payload.
- `exclude_paths` (list of string, optional) — Request paths to exclude from the payload, logs and created event. Known sensitive headers and query parameters are always excluded.

### DebounceSettings

- `key_paths` (list of string, optional) — Payload paths whose values identify duplicate requests.
- `window_seconds` (enum, optional) — Maximum debounce window in seconds, starting at the first request with a given key. Allowed: 0, 30, 60, 180, 300, 600, 900, 1800, 2700, 3600; 0 disables debouncing.
  - Allowed values: `0`, `30`, `60`, `180`, `300`, `600`, `900`, `1800`, `2700`, `3600`

### ChallengeSettings

- `detection_dsl` (string, optional) — Moveworks DSL rule that decides whether an incoming request is a challenge rather than an event. Evaluated against request_body, headers and query_params.
- `tokens` (list of ChallengeTokenSettings, optional) — Signed tokens computed for the challenge, each available to the response by its name.
- `response` (HTTPResponseSettings, optional) — The HTTP response returned to a challenge request.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ArgumentSettings

- `name` (string, optional) — Name of the argument. Must start with a letter and contain only letters, digits and underscores; 2 to 64 characters.
- `description` (string, optional) — Description of the argument. 2 to 256 characters.
- `type` (TypeSettings, optional) — Data type of the argument, e.g. string, List[User] or a custom type. Required.
- `required` (boolean, optional) — If true, a value must be provided for this argument.
- `default_value` (ArgumentSettingsDefaultValue, optional, nullable) — Value used for this argument when none is provided.
- `example_value` (ArgumentSettingsExampleValue, optional, nullable) — Example value for this argument.

### FunctionSignatureSettingsResultSchema

JSON schema describing the function's output.

### IPAllowlistSettings

- `ip_addresses` (list of string, optional) — Individual IPv4 addresses allowed to call the endpoint.
- `cidr_blocks` (list of string, optional) — IPv4 address ranges in CIDR notation allowed to call the endpoint, for example 131.10.55.70/8.

### ValidationSettings

- `rule_dsl` (string, optional) — Moveworks DSL rule that validates the request. Evaluated against request_body, headers and query_params.
- `signature_verification` (SignatureVerificationSettings, optional) — Verifies the request's signature using a secret shared with the external system.

### ContentSettings

- `json` (JsonContentSettings, optional) — The request body is JSON.
- `form_url_encoded` (FormUrlEncodedContentSettings, optional) — The request body is form URL-encoded.

### PayloadSettingsMapperBender

Optional Moveworks data mapping that builds the event payload from the request. If unset, the request data itself becomes the payload.

### ChallengeTokenSettings

- `name` (string, optional) — Name the token is referenced by in the response. Defaults to 'token' when only one token is defined.
- `signing_algorithm` (enum, optional) — The signing algorithm used for the token: HS1, HS256, HS384 or HS512.
  - Allowed values: `HS1`, `HS256`, `HS384`, `HS512`
- `signing_secret` (string, optional) — The secret used to sign the token. Secret: always returned masked as *****.
- `payload_bender` (ChallengeTokenSettingsPayloadBender, optional) — Moveworks data mapping that builds the value to sign. Required.

### HTTPResponseSettings

- `status_code` (enum, optional) — The HTTP status code to return, such as 200. 0 uses the default, 200.
  - Allowed values: `0`, `100`, `101`, `102`, `103`, `200`, `201`, `202`, `203`, `204`, `205`, `206`, `207`, `208`, `226`, `300`, `301`, `302`, `303`, `304`, `305`, `307`, `308`, `400`, `401`, `402`, `403`, `404`, `405`, `406`, `407`, `408`, `409`, `410`, `411`, `412`, `413`, `414`, `415`, `416`, `417`, `418`, `421`, `422`, `423`, `424`, `425`, `426`, `428`, `429`, `431`, `451`, `500`, `501`, `502`, `503`, `504`, `505`, `506`, `507`, `508`, `510`, `511`
- `headers_bender` (HttpResponseSettingsHeadersBender, optional) — Moveworks data mapping that builds the response headers. Challenge tokens are available by name.
- `body_bender` (HttpResponseSettingsBodyBender, optional) — Moveworks data mapping that builds the response body. Challenge tokens are available by name.

### TypeSettings

- `primitive` (enum, optional) — A primitive type. One of: string, integer, number, boolean, array, object.
  - Allowed values: `string`, `integer`, `number`, `boolean`, `array`, `object`
- `native` (enum, optional) — A Moveworks-defined type. One of: User, File, ariba.v1.CatalogItem, workday.v1.JobProfile, Room, Group.
  - Allowed values: `User`, `File`, `ariba.v1.CatalogItem`, `workday.v1.JobProfile`, `Room`, `Group`
- `custom` (string, optional) — Name of a custom type registered in your organization. ID of an existing data_type (GET /configurations/v1alpha1/platform/extensions/data-types).
- `list` (boolean, optional) — If true, the argument is a list of the selected type rather than a single value.

### ArgumentSettingsDefaultValue

Value used for this argument when none is provided.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### ArgumentSettingsExampleValue

Example value for this argument.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### SignatureVerificationSettings

- `secret_token` (string, optional) — The shared secret the external system uses to sign requests. Secret: always returned masked as *****.
- `signing_algorithm` (string, optional) — The signing algorithm the external system uses: HS1, HS256, HS384, HS512, or HMAC_INFERRED to detect it from the signature's prefix.
- `signature_payload_bender` (SignatureVerificationSettingsSignaturePayloadBender, optional) — Moveworks data mapping that builds the payload the signature is computed over.
- `received_signature_bender` (SignatureVerificationSettingsReceivedSignatureBender, optional) — Moveworks data mapping that extracts the received signature from the request.

### JsonContentSettings

- `schema` (JsonContentSettingsSchema, optional) — JSON Schema the payload is validated against before the event is created.

### FormUrlEncodedContentSettings

- `schema` (FormUrlEncodedContentSettingsSchema, optional) — JSON Schema the parsed form payload is validated against before the event is created.

### ChallengeTokenSettingsPayloadBender

Moveworks data mapping that builds the value to sign. Required.

### HttpResponseSettingsHeadersBender

Moveworks data mapping that builds the response headers. Challenge tokens are available by name.

### HttpResponseSettingsBodyBender

Moveworks data mapping that builds the response body. Challenge tokens are available by name.

### SignatureVerificationSettingsSignaturePayloadBender

Moveworks data mapping that builds the payload the signature is computed over.

### SignatureVerificationSettingsReceivedSignatureBender

Moveworks data mapping that extracts the received signature from the request.

### JsonContentSettingsSchema

JSON Schema the payload is validated against before the event is created.

### FormUrlEncodedContentSettingsSchema

JSON Schema the parsed form payload is validated against before the event is created.

## Examples

**Response**

```json
[
  {
    "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
    "display_name": "Ticket closed events",
    "signature": {
      "name": "ticket_closed",
      "description": "Emitted by the ticketing system when a ticket is closed.",
      "arguments": [
        {
          "name": "ticket_id",
          "description": "The closed ticket's id.",
          "type": {
            "primitive": "string"
          },
          "required": true
        }
      ],
      "display_name": "Ticket Closed"
    },
    "log_redaction_enabled": true,
    "verification": {
      "validations": [
        {
          "signature_verification": {
            "secret_token": "••••••••",
            "signing_algorithm": "HS256",
            "signature_payload_bender": {
              "payload": "request_body"
            },
            "received_signature_bender": {
              "signature": "headers.x-signature"
            }
          }
        }
      ]
    },
    "payload": {
      "mapper_bender": {
        "ticket_id": "request_body.ticket_id"
      }
    },
    "debounce": {
      "key_paths": [
        "ticket_id"
      ],
      "window_seconds": 60
    },
    "updated_time": "2026-11-12T18:04:11Z",
    "updated_by": "admin@example.com",
    "version": {
      "num": 2,
      "change_description": "Initial version."
    }
  }
]
```

**SDK Code**

```python Webhook Listeners endpoints_listWebhookListeners_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Webhook Listeners endpoints_listWebhookListeners_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Webhook Listeners endpoints_listWebhookListeners_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Webhook Listeners endpoints_listWebhookListeners_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Webhook Listeners endpoints_listWebhookListeners_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Webhook Listeners endpoints_listWebhookListeners_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Webhook Listeners endpoints_listWebhookListeners_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Webhook Listeners endpoints_listWebhookListeners_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/listeners")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```