> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cabrapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# List Store Webhooks

> Returns all webhooks registered for a store and the maximum limit allowed by the plan.

## 📋 List Store Webhooks

This endpoint allows listing all webhooks registered for a specific store, in addition to informing the maximum number of webhooks allowed by the store's plan.

### 🔐 Authentication

This route requires authentication via API Key, sent in the request header:

```http theme={null}
Authorization: YOUR_API_KEY_HERE
```

### 📥 Route Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `storeId` | `string (UUID)` | Yes | Store ID |

### 📋 Request Example

```bash theme={null}
curl --location "https://api.cabrapi.com.br/v1/stores/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/webhooks" \
--header "Authorization: YOUR_API_KEY_HERE"
```

### 📊 Response Example (200)

```json theme={null}
{
  "webhooks": [
    {
      "url": "https://meusistema.com/callback1",
      "events": [
        "payment.status.changed",
        "payment.updated"
      ]
    }
  ],
  "max": 3
}
```

### ❌ Possible Errors

| Status | Code | When it happens |
| - | - | - |
| `400` | `STORE_ID_REQUIRED` | Dead code: the route requires `storeId`; never fires in practice. |
| `401` | `API_KEY_NOT_PROVIDED` | `Authorization` header not sent. |
| `401` | `INVALID_API_KEY` | Invalid or not found API Key. |
| `403` | `USER_DISABLED` | User account disabled or deleted. |
| `403` | `NO_ACTIVE_SUBSCRIPTION` | Account has no active plan. |
| `404` | `STORE_NOT_FOUND` | When the store does not exist or does not belong to your account. |
| `429` | `RATE_LIMIT_EXCEEDED` | Plan per-minute request limit exceeded. |
| `503` | `SERVICE_UNAVAILABLE` | Service temporarily unavailable. |

> **Updating events:** To update the `events` list of an already registered webhook, use `PUT` or `PATCH /v1/stores/{storeId}/webhooks` with `url` and `events` (returns `200` with `code: "WEBHOOK_UPDATED"`).


## OpenAPI

````yaml GET /stores/{storeId}/webhooks
openapi: 3.1.0
info:
  title: caBRAPI
  version: 1.0.0
servers:
  - url: https://api.cabrapi.com.br/v1
security: []
paths:
  /stores/{storeId}/webhooks:
    get:
      tags:
        - Webhooks
      summary: List store webhooks
      operationId: listWebhooks
      parameters:
        - $ref: '#/components/parameters/StoreId'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  max:
                    example: 3
                    type: integer
                  webhooks:
                    items:
                      $ref: '#/components/schemas/Webhook'
                    type: array
                required:
                  - webhooks
                  - max
                type: object
          description: List store webhooks.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden (inactive plan or insufficient permissions).
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Resource not found.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Rate limit exceeded.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Service unavailable.
      security:
        - ApiKey: []
components:
  parameters:
    StoreId:
      in: path
      name: storeId
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 50
  schemas:
    Webhook:
      description: Store webhook (events and delivery URL).
      properties:
        events:
          items:
            enum:
              - store.created
              - store.updated
              - store.deleted
              - store.reordered
              - product.created
              - product.updated
              - product.deleted
              - product.reordered
              - category.created
              - category.updated
              - category.deleted
              - category.reordered
              - coupon.created
              - coupon.updated
              - coupon.deleted
              - coupon.reordered
              - page.upserted
              - page.deleted
              - affiliate.created
              - affiliate.updated
              - affiliate.deleted
              - payment.created
              - payment.updated
              - payment.deleted
              - payment.status.changed
            type: string
          type: array
        url:
          format: uri
          type: string
      required:
        - url
        - events
      type: object
    Error:
      properties:
        code:
          example: STORE_NOT_FOUND
          type: string
      required:
        - code
      type: object
  securitySchemes:
    ApiKey:
      in: header
      name: Authorization
      type: apiKey
      x-default: YOUR_API_KEY_HERE

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.