# List Webhooks ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /webhook: get: summary: List Webhooks deprecated: false description: >- Retrieves webhook configurations for a specific organizational unit. Returns webhook endpoint URLs, trigger events, authentication settings, and delivery status. Supports pagination and filtering. operationId: getList tags: - V2 API Documentation/Webhook - Webhook parameters: - name: ouId in: query description: >- Organization unit (group) ID. Required integer. Scopes the request to this org unit. required: true schema: type: integer format: int32 examples: - 70035 - name: limit in: query description: >- Maximum number of records to return per page. Integer, default 100, max 2000, min 1. required: false schema: type: integer format: int32 minimum: 1 maximum: 2000 default: 100 examples: - 10 - name: offset in: query description: >- Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination. required: false schema: type: integer format: int32 minimum: 0 maximum: 100000 default: 0 examples: - 0 - name: filter in: query description: >- URL-encoded comma-separated list of filter conditions in the form ' ' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint. required: false schema: type: array items: type: string maxItems: 10 minItems: 1 examples: - status:active responses: '200': description: Webhook configurations with endpoints, events, and settings content: application/json: schema: $ref: '#/components/schemas/WebhookResponse' headers: X-Request-Id: description: Unique request identifier for debugging and tracing schema: type: string example: 550e8400-e29b-41d4-a716-446655440000 X-RateLimit-Limit: description: Maximum number of requests per minute (30) schema: type: integer example: 30 X-RateLimit-Remaining: description: Requests remaining in the current window schema: type: integer example: 25 X-RateLimit-Reset: description: Seconds remaining until the rate limit resets schema: type: integer example: 45 x-apidog-name: '' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/BadRequestResponseDto' headers: {} x-apidog-name: '' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponseDto' headers: {} x-apidog-name: '' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponseDto' headers: {} x-apidog-name: '' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponseDto' headers: {} x-apidog-name: '' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponseDto' headers: {} x-apidog-name: '' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' headers: {} x-apidog-name: '' security: - BearerAuth1: [] x-apidog: schemeGroups: - id: BV31hDrRDx2S61vaIpfLJ schemeIds: - BearerAuth1 required: true use: id: BV31hDrRDx2S61vaIpfLJ scopes: BV31hDrRDx2S61vaIpfLJ: BearerAuth1: [] x-apidog-folder: V2 API Documentation/Webhook x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1215371/apis/api-31749922-run components: schemas: WebhookResponse: type: object required: - result - data properties: result: type: string description: Outcome of the request. String, typically 'success' or 'error'. err: type: string description: Error message when result='error'. String. Empty/null on success. data: type: object properties: webhook_id: type: integer format: int32 description: >- Unique identifier representing the webhook. Type: integer (int32). webhook_name: type: string description: 'Client defined name for the webhook. Type: string.' target_url: type: string description: 'A client provided Url for the webhook. Type: string.' description: Response payload. Shape varies by endpoint. x-apidog-orders: - webhook_id - webhook_name - target_url x-apidog-ignore-properties: [] x-apidog-orders: - result - err - data x-apidog-ignore-properties: [] x-apidog-folder: '' BadRequestResponseDto: type: object properties: statusCode: type: number examples: - 400 message: type: string examples: - Validation failed error: type: string examples: - Bad Request requestId: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 x-apidog-orders: - statusCode - message - error - requestId x-apidog-ignore-properties: [] x-apidog-folder: '' UnauthorizedResponseDto: type: object properties: statusCode: type: number examples: - 401 message: type: string examples: - Unauthorized error: type: string examples: - Unauthorized requestId: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 x-apidog-orders: - statusCode - message - error - requestId x-apidog-ignore-properties: [] x-apidog-folder: '' ForbiddenResponseDto: type: object properties: statusCode: type: number examples: - 403 message: type: string examples: - Forbidden error: type: string examples: - Forbidden requestId: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 x-apidog-orders: - statusCode - message - error - requestId x-apidog-ignore-properties: [] x-apidog-folder: '' NotFoundResponseDto: type: object properties: statusCode: type: number examples: - 404 message: type: string examples: - Resource not found error: type: string examples: - Not Found requestId: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 x-apidog-orders: - statusCode - message - error - requestId x-apidog-ignore-properties: [] x-apidog-folder: '' InternalServerErrorResponseDto: type: object properties: statusCode: type: number examples: - 500 message: type: string examples: - Internal server error error: type: string examples: - Internal Server Error requestId: type: string examples: - 550e8400-e29b-41d4-a716-446655440000 x-apidog-orders: - statusCode - message - error - requestId x-apidog-ignore-properties: [] x-apidog-folder: '' Error: type: object required: - result - err properties: result: type: string description: Specifies the outcome of the request made err: type: string description: Message of the error that occurred data: type: string description: This will be blank on error return x-apidog-orders: - result - err - data x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: BearerAuth: scheme: bearer bearerFormat: Token type: bearer BearerAuth1: type: bearer scheme: bearer bearerFormat: Token description: >- Access token from POST /oauth/token. Include in Authorization header as: `Bearer ` Token is valid for 1 hour and auto-renews on each authenticated API request. When expired, use refresh token to get new token pair. BearerAuth2: type: bearer scheme: bearer bearerFormat: Token description: > Access token obtained from POST /oauth/token. **Usage:** Include in Authorization header as: ``` Authorization: Bearer ``` **Lifetime:** Token is valid for 1 hour (3600 seconds) **Auto-renewal:** Token TTL is automatically refreshed on each authenticated API request **Expiration:** When expired, use refresh token to obtain new token pair via POST /oauth/token with grant_type=refresh_token BearerAuth3: scheme: bearer bearerFormat: Token type: bearer servers: - url: '' description: Production security: [] ```