> ## 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.

# Listar Webhooks da Loja

> Retorna todos os webhooks cadastrados para uma loja e o limite máximo permitido pelo plano.

## 📋 Listar Webhooks da Loja

Este endpoint permite listar todos os webhooks cadastrados para uma loja específica, além de informar o limite máximo de webhooks permitido pelo plano da loja.

### 🔐 Autenticação

Esta rota exige autenticação via API Key, enviada no header da requisição:

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

### 📥 Parâmetros de Rota

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `storeId` | `string (UUID)` | Sim | ID da loja |

### 📋 Exemplo de Requisição

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

### 📊 Exemplo de Resposta (200)

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

### ❌ Possíveis Erros

| Status | Code | Quando acontece |
| - | - | - |
| `400` | `STORE_ID_REQUIRED` | Código morto: a rota exige `storeId`; nunca dispara na prática. |
| `401` | `API_KEY_NOT_PROVIDED` | Header `Authorization` não enviado. |
| `401` | `INVALID_API_KEY` | API Key inválida ou não encontrada. |
| `403` | `USER_DISABLED` | Conta do usuário desativada ou excluída. |
| `403` | `NO_ACTIVE_SUBSCRIPTION` | Conta sem plano ativo. |
| `404` | `STORE_NOT_FOUND` | Quando a loja não existe ou não pertence à sua conta. |
| `429` | `RATE_LIMIT_EXCEEDED` | Limite de requisições por minuto do plano excedido. |
| `503` | `SERVICE_UNAVAILABLE` | Serviço temporariamente indisponível. |

> **Atualização de eventos:** Para atualizar a lista de `events` de um webhook já cadastrado, utilize `PUT` ou `PATCH /v1/stores/{storeId}/webhooks` enviando `url` e `events` (retorna `200` com `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.