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

# Criar um tópico

<Info>
  Exige a ação IAM **`notifications:CreateTopic`**. Veja [NOTIFICATIONS permissões](/pt/notifications/permissions) para a lista completa, o escopo de cada ação e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/notifications.yaml post /v1/topics
openapi: 3.0.3
info:
  title: API Basaltic Notifications
  version: 1.0.0
  description: >-
    Tópicos de publicação e assinatura com entrega por email, webhook e fila.
    Publicar distribui a mensagem a cada assinatura confirmada cujo filtro
    corresponda.


    A publicação é assíncrona: 202 confirma armazenamento e enfileiramento, não
    entrega. Consulte `GET /v1/topics/{topic_id}/messages/{message_id}` para o
    estado de distribuição e `GET /v1/topics/{topic_id}/deliveries?message=...`
    para resultados por destino.


    Email e webhooks começam em `pending_confirmation` e recebem um token: link
    por email ou POST `subscription_confirmation`. A janela é de 72 horas;
    assinaturas não confirmadas são removidas depois. `POST
    /v1/topics/{topic_id}/subscriptions/{id}/resend-confirmation` gera outro
    token; somente o hash é armazenado.


    Webhooks precisam de endereços públicos. Loopback, RFC1918, link-local e
    unique-local são recusados na assinatura e na entrega. Cada POST inclui
    `X-Basaltic-Signature: v1,t=<unix-seconds>,s=<hex>`, um HMAC-SHA256 sobre
    `"<t>.<raw-request-body>"` com o segredo da assinatura. O segredo é
    retornado na criação e pode ser consultado no endpoint próprio. Verifique o
    corpo original, sem serializá-lo novamente, e rejeite timestamps com mais de
    cinco minutos de diferença.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://notifications.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
tags:
  - name: Topics
    description: Tópicos de distribuição
  - name: Subscriptions
    description: Assinaturas de destinos e confirmação
  - name: Messages
    description: Publicação e status de entrega
  - name: Confirmations
    description: Ações sem autenticação do proprietário do destino
paths:
  /v1/topics:
    post:
      tags:
        - Topics
      summary: Criar um tópico
      operationId: createTopic
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTopicRequest'
      responses:
        '201':
          description: Tópico criado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopicResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Já existe um tópico com este nome na conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave opcional gerada pelo cliente que torna uma criação segura para
        reprodução. A reintentar uma solicitação com a mesma chave retorna o
        resultado original literalmente em vez de criar um recurso duplicado. A
        reutilização de uma chave com um corpo de solicitação diferente é
        rejeitada (422); uma solicitação cuja chave ainda está sendo processada
        retorna 409. Os registros são honrados por 24 horas. Use um UUID ou
        token exclusivo semelhante.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CreateTopicRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: >-
            De 1 a 256 letras, dígitos, pontos, hífens ou sublinhados. Nomes não
            podem começar com crn: nem ser UUIDs em formato canônico, compacto,
            entre chaves ou urn:uuid:, independentemente de maiúsculas.
          example: prod-alerts
        display_name:
          type: string
          maxLength: 100
          example: Production alerts
        delivery_policy:
          $ref: '#/components/schemas/DeliveryPolicy'
        tags:
          $ref: '#/components/schemas/Tags'
    TopicResponse:
      type: object
      required:
        - topic
      properties:
        topic:
          $ref: '#/components/schemas/Topic'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    DeliveryPolicy:
      type: object
      description: >-
        Política de tentativas. Campos omitidos herdam o tópico e depois os
        padrões: 6 tentativas, espera exponencial de 20s a 20min com variação
        aleatória e timeout de 15s. A herança ocorre por campo; alterar
        `max_attempts` preserva a curva do tópico.
      properties:
        max_attempts:
          type: integer
          minimum: 1
          maximum: 10
          description: >-
            Total de tentativas, incluindo a primeira. 1 desativa novas
            tentativas.
          example: 6
        min_delay_seconds:
          type: integer
          minimum: 1
          maximum: 3600
          description: Espera antes da segunda tentativa.
          example: 20
        max_delay_seconds:
          type: integer
          minimum: 1
          maximum: 3600
          description: Limite da curva exponencial.
          example: 1200
        timeout_seconds:
          type: integer
          minimum: 1
          maximum: 30
          description: Timeout por solicitação. Ignorado para email.
          example: 15
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    Topic:
      type: object
      required:
        - id
        - crn
        - name
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
        crn:
          type: string
          example: crn:notifications:sa-saopaulo-1:my-account:topic/prod-alerts
        name:
          type: string
          description: >-
            Exclusivo na conta e imutável. Não pode começar com crn: nem ser
            UUID em formato canônico, compacto, entre chaves ou urn:uuid:,
            independentemente de maiúsculas.
          example: prod-alerts
        display_name:
          type: string
          description: >-
            Nome de exibição; usado como assunto do email quando a notificação
            não fornece um.
          example: Production alerts
        delivery_policy:
          $ref: '#/components/schemas/DeliveryPolicy'
        tags:
          $ref: '#/components/schemas/Tags'
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-18T11:45:00Z'
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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