# place.stream.server.listWebhooks

> Published by [did:web:longos.iameli.link](https://lexicon.garden/identity/did:web:longos.iameli.link)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:longos.iameli.link/place.stream.server.listWebhooks)
- [Documentation](https://lexicon.garden/lexicon/did:web:longos.iameli.link/place.stream.server.listWebhooks/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:longos.iameli.link/place.stream.server.listWebhooks/examples)

## Definitions

### `place.stream.server.listWebhooks`

**Type**: `query`

List webhooks for the authenticated user.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `event` | `string` | No | Filter webhooks that handle this event type. |
| `limit` | `integer` | No | The number of webhooks to return. |
| `active` | `boolean` | No | Filter webhooks by active status. |
| `cursor` | `string` | No | An optional cursor for pagination. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | A cursor for pagination, if there are more results. |
| `webhooks` | `array` | Yes |  |

#### Errors

- **InvalidCursor**: The provided cursor is invalid or expired.

## Raw Schema

```json
{
  "id": "place.stream.server.listWebhooks",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "InvalidCursor",
          "description": "The provided cursor is invalid or expired."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "webhooks"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "A cursor for pagination, if there are more results."
            },
            "webhooks": {
              "type": "array",
              "items": {
                "ref": "place.stream.server.defs#webhook",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "event": {
            "enum": [
              "chat",
              "livestream",
              "follow",
              "mention"
            ],
            "type": "string",
            "description": "Filter webhooks that handle this event type."
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "The number of webhooks to return."
          },
          "active": {
            "type": "boolean",
            "description": "Filter webhooks by active status."
          },
          "cursor": {
            "type": "string",
            "description": "An optional cursor for pagination."
          }
        }
      },
      "description": "List webhooks for the authenticated user."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
