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

# Get Webhook

> Retrieve details of a single webhook including its status, event types, and delivery information.



## OpenAPI

````yaml GET /webhooks/{webhookId}
openapi: 3.1.0
info:
  title: Lettr API
  version: 1.0.0
  description: >-
    Lettr Email API - Send transactional emails with tracking, attachments, and
    personalization.
  contact:
    name: Lettr Support
    url: https://lettr.com
  license:
    name: Proprietary
    url: https://lettr.com/terms
servers:
  - url: https://app.lettr.com/api
    description: Production
security: []
tags:
  - name: Emails
    description: Email sending operations
  - name: Templates
    description: Email template management operations
  - name: Domains
    description: Domain management operations
  - name: Webhooks
    description: Webhook management operations
  - name: Audience
    description: 'Audience management: lists, contacts, topics, properties, and segments'
  - name: Campaigns
    description: >-
      Campaign operations: listing, stats, engagement events, and
      dispatch/scheduling
paths:
  /webhooks/{webhookId}:
    get:
      tags:
        - Webhooks
      summary: Get Webhook
      description: >-
        Retrieve details of a single webhook including its status, event types,
        and delivery information.
      operationId: showWebhook
      parameters:
        - name: webhookId
          in: path
          required: true
          description: The webhook ID to retrieve
          schema:
            type: string
            example: webhook-abc123
      responses:
        '200':
          description: Webhook retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShowWebhookResponse'
              example:
                message: Webhook retrieved successfully.
                data:
                  id: webhook-abc123
                  name: Order Notifications
                  url: https://example.com/webhook
                  enabled: true
                  event_types:
                    - message.delivery
                    - message.bounce
                  auth_type: basic
                  has_auth_credentials: true
                  last_successful_at: '2024-01-15T10:30:00+00:00'
                  last_failure_at: null
                  last_status: success
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          description: Webhook not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Webhook not found.
                error_code: not_found
        '500':
          description: Server error - Failed to retrieve webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Failed to retrieve webhook. Please try again later.
                error_code: send_error
      security:
        - bearerAuth: []
components:
  schemas:
    ShowWebhookResponse:
      type: object
      description: Response containing a single webhook
      required:
        - message
        - data
      properties:
        message:
          type: string
          description: Human-readable response message
          example: Webhook retrieved successfully.
        data:
          $ref: '#/components/schemas/WebhookView'
    ErrorResponse:
      type: object
      required:
        - message
        - error_code
      description: Error response for non-validation errors (400, 409, 500, 502).
      properties:
        message:
          type: string
          description: Human-readable error message
          example: The sender domain could not be determined from the email address.
        error_code:
          $ref: '#/components/schemas/ErrorCode'
    WebhookView:
      type: object
      description: View of a webhook
      required:
        - id
        - name
        - url
        - enabled
        - auth_type
        - has_auth_credentials
      properties:
        id:
          type: string
          description: Unique identifier for the webhook
          example: webhook-abc123
        name:
          type: string
          description: Name of the webhook
          example: Order Notifications
        url:
          type: string
          format: uri
          description: URL where webhook events will be sent
          example: https://example.com/webhook
        enabled:
          type: boolean
          description: Whether the webhook is enabled
          example: true
        event_types:
          type:
            - array
            - 'null'
          description: Specific event types the webhook receives (null if all events)
          items:
            type: string
          example:
            - message.delivery
            - message.bounce
        auth_type:
          type: string
          description: Authentication type for the webhook (none, basic, oauth2)
          example: basic
        has_auth_credentials:
          type: boolean
          description: Whether authentication credentials are configured
          example: true
        last_successful_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of the last successful webhook delivery
          example: '2024-01-15T10:30:00+00:00'
        last_failure_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of the last failed webhook delivery
          example: null
        last_status:
          type:
            - string
            - 'null'
          description: Status of the last delivery attempt (success or failure)
          enum:
            - success
            - failure
            - null
          example: success
    UnauthorizedResponse:
      type: object
      required:
        - message
      description: Error response for authentication failures (401).
      properties:
        message:
          type: string
          description: Human-readable error message
          example: API key is required.
    ErrorCode:
      type: string
      description: >-
        Error codes returned by the API.


        | Code | HTTP Status | Description |

        |------|-------------|-------------|

        | `validation_error` | 422 | Request validation failed. Check the
        `errors` object for field-specific messages. |

        | `invalid_domain` | 400 | The sender domain could not be determined
        from the email address. |

        | `unconfigured_domain` | 400 | The sender domain is not configured or
        approved for sending. |

        | `send_error` | 400, 500 | General error during email send preparation
        or domain registration. |

        | `retrieval_error` | 400, 500 | Failed to retrieve resources (e.g.,
        sandbox key without associated user, upstream error). |

        | `transmission_failed` | 502 | Email transmission to the upstream
        provider failed. |

        | `resource_already_exists` | 409 | The resource (e.g., domain) already
        exists. |

        | `not_found` | 404 | The specified resource was not found. |

        | `template_not_found` | 404 | The specified template, project, or
        template version was not found. |

        | `insufficient_scope` | 403 | The API key does not have the required
        scope for this endpoint. |

        | `schedule_cancellation_failed` | 409, 500 | Could not cancel the
        scheduled transmission (already sent or upstream error). |

        | `quota_exceeded` | 429 | Monthly sending quota exceeded. Upgrade your
        plan to continue sending. |

        | `daily_quota_exceeded` | 429 | Daily sending quota exceeded. Try again
        tomorrow. |

        | `campaign_not_sendable` | 422 | The campaign cannot be sent in its
        current state (not a draft, or missing subject/sender/content). |

        | `campaign_not_scheduled` | 422 | The campaign is not scheduled, so it
        cannot be unscheduled. |
      enum:
        - validation_error
        - invalid_domain
        - unconfigured_domain
        - send_error
        - retrieval_error
        - transmission_failed
        - resource_already_exists
        - not_found
        - template_not_found
        - insufficient_scope
        - schedule_cancellation_failed
        - quota_exceeded
        - daily_quota_exceeded
        - campaign_not_sendable
        - campaign_not_scheduled
      example: invalid_domain
  responses:
    UnauthorizedError:
      description: Unauthorized - Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedResponse'
          examples:
            missing_key:
              summary: Missing API key
              value:
                message: API key is required.
            invalid_key:
              summary: Invalid API key
              value:
                message: Invalid API key.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key for authentication

````