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

# Aviso da Notaas

> Recebe o desfecho da nota fiscal: emitida, recusada ou cancelada.



## OpenAPI

````yaml POST /webhooks/notaas
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
paths:
  /webhooks/notaas:
    post:
      tags:
        - clubs
      summary: Aviso da Notaas
      description: >
        A Notaas avisa o desfecho de uma nota fiscal (NFS-e) que pedimos:
        emitida,

        recusada pela prefeitura, ou cancelada. Anônima por natureza, e
        protegida

        pela assinatura `X-Notaas-Signature` (`sha256=` + HMAC-SHA256 do corpo
        cru),

        conferida com `NOTAAS_WEBHOOK_SECRET` antes de ler o corpo.


        A nota é achada pelo id que a Notaas devolveu na emissão. O que não é

        desfecho de nota (lote, documentos prontos) e a nota que não é nossa

        respondem 200 e são ignorados. Aplicar é idempotente, e um aviso
        atrasado de

        erro não rebaixa uma nota já emitida.
      operationId: receiveNotaasWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Aviso aceito
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          description: Assinatura ausente ou que não confere (`invalid_signature`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '501':
          $ref: '#/components/responses/NotConfigured'
components:
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotConfigured:
      description: |
        O ambiente não tem o que a operação precisa (`not_configured`): o
        provedor de autenticação nas rotas de sessão, o e-mail nas que
        enviam link, a chave de cifra nos webhooks.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string

````

## Related topics

- [Aviso da Stripe](/api-reference/clubs/stripe-webhook.md)
- [Aviso da sala](/api-reference/lives/webhook.md)
- [Marcar avisos como lidos](/api-reference/comments/notifications-read.md)
- [Aviso do provedor de vídeo](/api-reference/media/webhook.md)
- [Aviso do provedor de e-mail](/api-reference/email/webhook.md)