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

# Detalhe da entrega

> Payload enviado, resposta HTTP do seu endpoint, tentativas e metadados.



## OpenAPI

````yaml /es/guides/webhooks/api-reference/openapi-webhooks.json get /v1/webhooks/deliveries/{deliveryId}
openapi: 3.0.3
info:
  title: Notifique API. Webhooks
  description: >-
    Cadastre URLs HTTPS para receber eventos da Notifique em tempo real.
    Autentique com `Authorization: Bearer sk_live_...` ou `x-api-key`. Escopos:
    `webhooks:read`, `webhooks:manage`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfWhBearerAuth: []
  - ntfWhApiKeyHeader: []
tags:
  - name: Webhooks
    description: CRUD de endpoints de webhook do workspace.
  - name: Entregas
    description: Histórico e reenvio de tentativas de entrega de webhook.
paths:
  /v1/webhooks/deliveries/{deliveryId}:
    get:
      tags:
        - Entregas
      summary: Detalhe da entrega
      description: Payload enviado, resposta HTTP do seu endpoint, tentativas e metadados.
      operationId: ntfWh_getDelivery
      parameters:
        - name: deliveryId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Detalhe completo da entrega.
          content:
            application/json:
              example:
                success: true
                data:
                  id: cldel_01H...
                  webhookId: clwh_01HABC...
                  event: message.sent
                  success: false
                  httpStatus: 500
                  attempts: 2
                  payload:
                    event: message.sent
                    workspaceId: clws_...
                  responseBody: Internal Server Error
                  lastAttemptAt: '2026-08-14T19:56:00.000Z'
              schema:
                $ref: '#/components/schemas/ntfWh_GetDeliveryResponse'
        '401':
          $ref: '#/components/responses/Ntf_Unauthorized'
        '403':
          $ref: '#/components/responses/Ntf_Forbidden'
        '404':
          $ref: '#/components/responses/Ntf_NotFound'
components:
  schemas:
    ntfWh_GetDeliveryResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: string
            webhookId:
              type: string
            event:
              type: string
            success:
              type: boolean
            httpStatus:
              type: integer
            attempts:
              type: integer
            payload:
              type: object
              properties:
                event:
                  type: string
                workspaceId:
                  type: string
            responseBody:
              type: string
            lastAttemptAt:
              type: string
      example:
        success: true
        data:
          id: clxx...
          webhookId: clxx...
          event: string
          success: true
          httpStatus: 1
          attempts: 1
          payload:
            event: string
            workspaceId: clxx...
          responseBody: string
          lastAttemptAt: string
    Ntf_Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
        code:
          type: string
      example:
        success: false
        error: string
        message: string
        code: string
  responses:
    Ntf_Unauthorized:
      description: Chave ausente, inválida ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Ntf_Error'
          example:
            success: false
            error: Unauthorized
            message: Invalid API key
            code: UNAUTHORIZED
    Ntf_Forbidden:
      description: Escopo ausente ou recurso fora da permissão da chave.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Ntf_Error'
          example:
            success: false
            error: Forbidden
            message: Missing scope webhooks:manage
            code: FORBIDDEN
    Ntf_NotFound:
      description: Recurso não encontrado no workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Ntf_Error'
          example:
            success: false
            error: Not Found
            message: Webhook not found
            code: NOT_FOUND
  securitySchemes:
    ntfWhBearerAuth:
      type: http
      scheme: bearer
      description: API key `sk_live_...` ou `sk_test_...`.
    ntfWhApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternativa ao Bearer.

````