---
updatedAt: 2026-05-18T12:22:55.000Z
agentTools:
  projectIndex: https://doc.focusnfe.com.br/llms.txt
---

# Listar

Lista todos os gatilhos cadastrados para o token.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Webhooks",
    "version": "2.0.0",
    "contact": {
      "name": "Focus NFe Suporte",
      "email": "suporte@focusnfe.com.br"
    },
    "license": {
      "name": "Proprietary",
      "url": "https://focusnfe.com.br"
    }
  },
  "servers": [
    {
      "url": "https://api.focusnfe.com.br/v2",
      "description": "Servidor de Produção"
    },
    {
      "url": "https://homologacao.focusnfe.com.br/v2",
      "description": "Servidor de Homologação"
    }
  ],
  "security": [
    {
      "BasicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Webhooks",
      "description": "Operações relacionadas a criação, consulta, exclusão e teste de gatilhos"
    }
  ],
  "paths": {
    "/hooks": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Listar",
        "description": "Lista todos os gatilhos cadastrados para o token.",
        "operationId": "listar_webhooks",
        "responses": {
          "200": {
            "description": "Lista de gatilhos",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Hook"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Requisição inválida",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Autenticação com usuário e senha (HTTP Basic). O usuário é o token da API e a senha deve ser deixada em branco."
      }
    },
    "schemas": {
      "Hook": {
        "title": "Gatilho",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "authorization": {
            "type": "string",
            "nullable": true
          },
          "authorization_header": {
            "type": "string",
            "nullable": true
          },
          "event": {
            "type": "string",
            "description": "Evento monitorado",
            "enum": [
              "nfe",
              "nfse",
              "nfsen",
              "nfce_contingencia",
              "nfe_recebida",
              "nfe_recebida_falha_consulta",
              "nfsen_recebida",
              "cte_recebida",
              "inutilizacao",
              "cte",
              "mdfe",
              "nfcom",
              "nfce_consulta_automatica"
            ]
          },
          "cnpj": {
            "type": "string",
            "description": "CNPJ vinculado ao gatilho"
          },
          "cpf": {
            "type": "string",
            "description": "CPF vinculado ao gatilho"
          }
        },
        "example": {
          "id": "Vj5rmkBq",
          "url": "http://minha.url/nfe",
          "authorization": null,
          "authorization_header": null,
          "event": "nfe",
          "cnpj": "12345678000123"
        }
      },
      "ErrorResponse": {
        "title": "Erro",
        "type": "object",
        "properties": {
          "codigo": {
            "type": "string",
            "description": "Código do erro"
          },
          "mensagem": {
            "type": "string",
            "description": "Mensagem descritiva do erro"
          }
        }
      }
    }
  }
}
```