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

# Describir una suscripción

<Info>
  Requiere la acción IAM **`notifications:DescribeSubscription`**. Consulte [NOTIFICATIONS permisos](/es/notifications/permissions) para la lista completa, el alcance de cada acción y un ejemplo de política.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/notifications.yaml get /v1/topics/{topic_id}/subscriptions/{subscription_id}
openapi: 3.0.3
info:
  title: API Basaltic Notifications
  version: 1.0.0
  description: >-
    Temas de publicación y suscripción con entrega por email, webhook y cola.
    Publicar distribuye el mensaje a cada suscripción confirmada cuyo filtro
    coincida.


    La publicación es asíncrona: 202 confirma almacenamiento y encolado, no
    entrega. Consulte `GET /v1/topics/{topic_id}/messages/{message_id}` para el
    estado de distribución y `GET /v1/topics/{topic_id}/deliveries?message=...`
    para resultados por destino.


    Email y webhooks empiezan en `pending_confirmation` y reciben un token:
    enlace por email o POST `subscription_confirmation`. La ventana es de 72
    horas; las suscripciones no confirmadas se eliminan después. `POST
    /v1/topics/{topic_id}/subscriptions/{id}/resend-confirmation` genera otro
    token; solo se almacena el hash.


    Los webhooks necesitan direcciones públicas. Loopback, RFC1918, link-local y
    unique-local se rechazan al suscribirse y al entregar. Cada POST incluye
    `X-Basaltic-Signature: v1,t=<unix-seconds>,s=<hex>`, un HMAC-SHA256 sobre
    `"<t>.<raw-request-body>"` con el secreto de la suscripción. El secreto se
    devuelve al crear y puede consultarse en su endpoint. Verifique el cuerpo
    original, sin volver a serializarlo, y rechace timestamps con más de cinco
    minutos de diferencia.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://notifications.{region}.basaltic.sh
    description: Punto final de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de región
security:
  - BearerAuth: []
tags:
  - name: Topics
    description: Temas de distribución
  - name: Subscriptions
    description: Suscripciones de destinos y confirmación
  - name: Messages
    description: Publicación y estado de entrega
  - name: Confirmations
    description: Acciones sin autenticación del propietario del destino
paths:
  /v1/topics/{topic_id}/subscriptions/{subscription_id}:
    parameters:
      - $ref: '#/components/parameters/TopicId'
      - $ref: '#/components/parameters/SubscriptionId'
    get:
      tags:
        - Subscriptions
      summary: Describir una suscripción
      operationId: describeSubscription
      responses:
        '200':
          description: Metadatos de la suscripción, sin el secreto.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    TopicId:
      name: topic_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
    SubscriptionId:
      name: subscription_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
  schemas:
    SubscriptionResponse:
      type: object
      required:
        - subscription
      properties:
        subscription:
          $ref: '#/components/schemas/Subscription'
    Subscription:
      type: object
      required:
        - id
        - crn
        - protocol
        - endpoint
        - status
        - raw_message_delivery
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
        crn:
          type: string
          description: >-
            Anidado en el nombre real del tema y la cuenta propietaria,
            incluidas las suscripciones entre cuentas.
          example: >-
            crn:notifications:sa-saopaulo-1:my-account:topic/orders/subscription/b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
        protocol:
          type: string
          enum:
            - email
            - https
            - http
            - queue
          example: https
        endpoint:
          type: string
          description: >-
            Inmutable. Dirección de email, URL http/https o CRN canónico de la
            cola cuando el protocolo es queue.
          example: https://hooks.example.com/basaltic
        status:
          type: string
          enum:
            - pending_confirmation
            - confirmed
          example: confirmed
        raw_message_delivery:
          type: boolean
          description: >-
            Solo http/https. Entrega el contenido publicado sin envoltorio; los
            metadatos pasan a los encabezados.
          example: false
        filter_policy:
          $ref: '#/components/schemas/FilterPolicy'
        delivery_policy:
          $ref: '#/components/schemas/DeliveryPolicy'
        redrive_policy:
          $ref: '#/components/schemas/RedrivePolicy'
        confirmation_expires_at:
          type: string
          format: date-time
          nullable: true
          description: Vencimiento de la confirmación pendiente. Ausente tras confirmar.
          example: '2026-01-21T09:30:00Z'
        confirmed_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-18T09:31:00Z'
        tags:
          $ref: '#/components/schemas/Tags'
        created_at:
          type: string
          format: date-time
          example: '2026-01-18T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-18T09:31:00Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
    FilterPolicy:
      type: object
      maxProperties: 20
      description: >-
        Filtra atributos de la publicación, no campos del cuerpo. Cada atributo
        debe coincidir con una alternativa: AND entre nombres y OR dentro de
        cada lista. Los nombres y comparaciones distinguen mayúsculas. Una
        política omitida o vacía acepta todos los mensajes.


        Alternativas: cadenas o números exactos, u objetos con un operador:
        `{"prefix": "order."}`, `{"suffix": ".failed"}`, `{"anything-but":
        ["debug", "trace"]}`, `{"exists": true}`, `{"exists": false}` o
        `{"numeric": [">=", 100, "<", 1000]}`. Los prefijos y sufijos no pueden
        estar vacíos. `anything-but` acepta una cadena, número o lista de 1–50
        valores.


        Solo `exists: false` acepta un atributo ausente. La exclusión también
        exige presencia. Operadores numéricos: `=`, `<`, `<=`, `>` y `>=`; todos
        los pares deben ser verdaderos. Los valores no numéricos no coinciden.
        Los números simples comparan representaciones textuales; use `numeric`
        para la equivalencia entre "100" y "100.0".


        Hasta 20 nombres no vacíos, con 1–50 alternativas por nombre. Un
        operador por objeto. No hay comodines, expresiones regulares, filtros
        del cuerpo ni operadores anidados. PATCH sustituye toda la política;
        `{}` la borra y omitirla la conserva. Consulte [Políticas de
        filtro](/es/notifications/filter-policies).
      additionalProperties:
        type: array
        minItems: 1
        maxItems: 50
        items: {}
      example:
        event:
          - order.created
          - order.paid
        environment:
          - production
        amount:
          - numeric:
              - '>='
              - 100
              - <
              - 1000
        test:
          - exists: false
    DeliveryPolicy:
      type: object
      description: >-
        Política de reintentos. Los campos omitidos heredan el tema y después
        los valores predeterminados: 6 intentos, espera exponencial de 20s a
        20min con variación aleatoria y timeout de 15s. La herencia se aplica
        por campo; cambiar `max_attempts` conserva la curva del tema.
      properties:
        max_attempts:
          type: integer
          minimum: 1
          maximum: 10
          description: Total de intentos, incluido el primero. 1 desactiva los reintentos.
          example: 6
        min_delay_seconds:
          type: integer
          minimum: 1
          maximum: 3600
          description: Espera antes del segundo intento.
          example: 20
        max_delay_seconds:
          type: integer
          minimum: 1
          maximum: 3600
          description: Límite de la curva exponencial.
          example: 1200
        timeout_seconds:
          type: integer
          minimum: 1
          maximum: 30
          description: Timeout por solicitud. Se ignora para email.
          example: 15
    RedrivePolicy:
      type: object
      required:
        - dead_letter_queue
      properties:
        dead_letter_queue:
          allOf:
            - $ref: '#/components/schemas/ResourceRef'
          description: >-
            Cola vinculada. Un destino eliminado conserva ID y CRN almacenados,
            sin nombre.
          example:
            id: c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f
            crn: crn:queue:sa-saopaulo-1:my-account:queue/notification-failures
            name: notification-failures
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Etiqueta en el momento de la respuesta: el nombre del recurso, si lo
            tiene, o su etiqueta legible (número de factura, nombre de
            visualización de la cuenta). Ausente cuando el destino ya no existe.
            No es una clave de búsqueda.
          example: Brazil
  responses:
    Unauthorized:
      description: Se requiere autenticación o el token no es vá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: Permisos 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
    NotFound:
      description: No se encontró el recurso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. Esta es la forma recomendada de autenticación.


        Obtén el token intercambiando el par de claves de acceso de una cuenta
        de servicio en `POST /v1/oauth/token` con
        `grant_type=client_credentials`. Es el flujo estándar de credenciales de
        cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
        el token por ti.


        ```

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


        Los tokens duran una hora por defecto. El mismo par de claves de acceso
        también sirve como credencial AWS SigV4 para el endpoint de objetos
        compatible con S3, que solo acepta ese método de autenticación.


````

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