---
title: "Gets the list of web hooks for the authenticated subscription."
method: GET
path: "/webhooks"
tags: ["Custom Speech web hooks:"]
---

# Gets the list of web hooks for the authenticated subscription.

`GET /webhooks`

## Query parameters

- `skip` integer
- `top` integer
- `filter` string

## Response `200`

OK

- PaginatedWebHooks
  - `values` WebHook[] — A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list.
    - `webUrl` string, uri, required — The registered URL that will be used to send the POST requests for the registered events to.
    - `links` WebHookLinks
      - `ping` string, uri — The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation "WebHooks_Ping" for more details.
      - `test` string, uri — The URL that can be used sending test events to the registered URL of a web hook registration. See operation "WebHooks_Test" for more details.
    - `properties` WebHookProperties
      - `error` EntityError
        - `code` string — The code of this error.
        - `message` string — The message for this error.
      - `apiVersion` string — The API version the web hook was created in. This defines the shape of the payload in the callbacks. If the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation), the web hook will be disabled.
      - `secret` string — A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL.
    - `self` string, uri — The location of this entity.
    - `displayName` string, required — The display name of the object.
    - `description` string — The description of the object.
    - `events` WebHookEvents, required
      - `datasetCreation` boolean
      - `datasetProcessing` boolean
      - `datasetCompletion` boolean
      - `datasetDeletion` boolean
      - `modelCreation` boolean
      - `modelProcessing` boolean
      - `modelCompletion` boolean
      - `modelDeletion` boolean
      - `evaluationCreation` boolean
      - `evaluationProcessing` boolean
      - `evaluationCompletion` boolean
      - `evaluationDeletion` boolean
      - `transcriptionCreation` boolean
      - `transcriptionProcessing` boolean
      - `transcriptionCompletion` boolean
      - `transcriptionDeletion` boolean
      - `endpointCreation` boolean
      - `endpointProcessing` boolean
      - `endpointCompletion` boolean
      - `endpointDeletion` boolean
      - `ping` boolean
      - `challenge` boolean
    - `createdDateTime` string, date-time — The time-stamp when the object was created. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
    - `lastActionDateTime` string, date-time — The time-stamp when the current status was entered. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
    - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' — Describe the current state of the API
    - `customProperties` object — The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.
  - `@nextLink` string, uri — A link to the next set of paginated results if there are more entities available; otherwise null.

## Other responses

- `default` — An error occurred.

---

[API](https://skmtc.net/azure/apis/cognitiveservices-speech-speechtotext.md) · [All operations](https://skmtc.net/azure/apis/cognitiveservices-speech-speechtotext/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/cognitiveservices-speech-speechtotext/versions/931821089e0d/schema)