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

# Fazer ping em uma assinatura de webhook

> Executa uma sondagem (probe) de webhook síncrona e assinada pelo caminho de entrega de produção e retorna o resultado classificado. Um ping bem-sucedido transiciona uma assinatura `webhook` de `pending_verification` para `active`. Uma falha de sondagem classificada ainda é um `200` (a sondagem rodou e produziu um veredito). Esta rota é naturalmente idempotente e não exige o cabeçalho `X-Idempotency`. Uma assinatura de fila não tem sondagem de ping e retorna `422 probe_unsupported_for_sink_kind`.



## OpenAPI

````yaml pt/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/ping
openapi: 3.1.0
info:
  title: Lerian Streaming Hub API
  version: v1.0.0
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  license:
    name: Lerian Studio General License
  description: >-
    A API do plano de controle do Streaming Hub. O Streaming Hub é a borda
    gerenciada de entrega de eventos da Lerian: ele consome CloudEvents do
    backbone de streaming interno da plataforma e faz o fan-out para os destinos
    externos do próprio tenant — webhooks, Amazon SQS, RabbitMQ, Amazon
    EventBridge ou uma caixa de entrada pull. Esta API permite que um tenant
    navegue pelo catálogo de eventos alimentado por manifesto, crie e gerencie
    assinaturas de entrega, verifique e rotacione suas credenciais, consulte a
    saúde da entrega e puxe (pull) os eventos aos quais tem direito.


    Os erros usam um envelope plano `{"error":"<token>"}` (um token de baixa
    cardinalidade, legível por máquina — nunca problem+json do RFC 9457). As
    operações de mutação exigem um cabeçalho `X-Idempotency` para semântica de
    no-máximo-uma-vez (at-most-once); uma requisição repetida (replay) retorna a
    resposta original byte a byte com `X-Idempotency-Replayed: true`. O catálogo
    e a superfície de eventos por pull têm escopo de tenant através do JWT
    bearer; os endpoints operacionais de sondagem (`/healthz`, `/readyz`,
    `/version`, `/runtime`, `/metrics`) não exigem autenticação. O Streaming Hub
    é closed source sob a Lerian Studio General License.
servers:
  - url: https://streaming-hub.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: Catalog
    description: >-
      Navegue pelo catálogo de tipos de evento disponíveis para assinatura,
      alimentado por manifesto.
  - name: Subscriptions
    description: >-
      Crie, leia, atualize e exclua assinaturas de entrega e conduza o ciclo de
      vida de verificação do destino (ping, verify, credential, delegated grant,
      rotação de segredo, saúde).
  - name: Event Delivery
    description: >-
      Puxe (pull) os eventos aos quais uma assinatura de sink pull tem direito
      (leitura com cursor-como-confirmação).
  - name: Admin
    description: >-
      Análise forense de operador entre tenants (cross-tenant). Exige um escopo
      de autorização de operador.
  - name: Operational
    description: >-
      Sondagens não autenticadas de liveness, readiness, build, runtime e
      métricas.
paths:
  /v1/subscriptions/{id}/ping:
    post:
      tags:
        - Subscriptions
      summary: Fazer ping em uma assinatura de webhook
      description: >-
        Executa uma sondagem (probe) de webhook síncrona e assinada pelo caminho
        de entrega de produção e retorna o resultado classificado. Um ping
        bem-sucedido transiciona uma assinatura `webhook` de
        `pending_verification` para `active`. Uma falha de sondagem classificada
        ainda é um `200` (a sondagem rodou e produziu um veredito). Esta rota é
        naturalmente idempotente e não exige o cabeçalho `X-Idempotency`. Uma
        assinatura de fila não tem sondagem de ping e retorna `422
        probe_unsupported_for_sink_kind`.
      operationId: pingSubscription
      parameters:
        - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: >-
            A sondagem rodou; o corpo carrega o resultado classificado da
            tentativa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProbeResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ProbeUnsupported'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth: []
components:
  parameters:
    SubscriptionId:
      name: id
      in: path
      required: true
      description: The unique identifier of the subscription (UUIDv7).
      schema:
        type: string
        format: uuid
  schemas:
    ProbeResult:
      type: object
      additionalProperties: false
      description: >-
        The classified result of a synchronous probe (ping, verify, or
        credential write). A classified failure is still returned with HTTP
        `200` — the probe ran and produced a verdict. It carries no secret,
        endpoint, or detail string.
      properties:
        outcome:
          $ref: '#/components/schemas/Outcome'
        statusCode:
          type: integer
          description: >-
            The target's protocol status. For webhook probes, the HTTP status
            (`0` when none applies, e.g. a transport error or a blocked
            endpoint). For queue-kind credential probes, always `0`.
          examples:
            - 200
        errorClass:
          type: string
          description: A frozen taxonomy token classifying a failure. Empty on success.
          examples:
            - ''
      required:
        - outcome
        - statusCode
        - errorClass
    Outcome:
      type: string
      description: The classified verdict of a synchronous probe.
      enum:
        - ok
        - failed
    Error:
      type: object
      additionalProperties: false
      description: >-
        The flat error envelope used across the `/v1` and `/admin` surfaces. It
        carries a single low-cardinality, machine-readable token and never leaks
        secret material or internal detail. (A `403` from the authorization
        decision point is the one exception — its body is plain text.)
      properties:
        error:
          type: string
          description: The machine-readable error token.
          examples:
            - not_found
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        A autenticação falhou, ou não há contexto de tenant confiável. `error` é
        `unauthorized` (corpo uniforme — nenhuma razão é revelada).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        O ponto de decisão de autorização (authorization decision point) negou a
        requisição. O corpo é texto puro (não o envelope de erro JSON).
      content:
        text/plain:
          schema:
            type: string
    NotFound:
      description: >-
        O recurso está ausente, soft-deleted ou pertence a outro tenant — um
        `error` uniforme de `not_found` (sem oráculo de existência).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ProbeUnsupported:
      description: >-
        O tipo de sink não tem sondagem registrada para esta operação — `error`
        é `probe_unsupported_for_sink_kind`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalError:
      description: >-
        Uma falha de infraestrutura. `error` é `internal_error` (sanitizado; o
        detalhe é logado, nunca retornado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Um JWT bearer emitido pelo plugin-auth (lib-auth). A identidade do
        tenant é resolvida a partir das claims validadas do token; a superfície
        `/v1` nunca lê um tenant do corpo, do path ou da query. Chamadores de
        máquina obtêm um token via o fluxo client-credentials do plugin-auth. A
        superfície `/admin` autoriza contra um escopo de operador e não carrega
        contexto de tenant.

````