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

# Get a webhook endpoint



## OpenAPI

````yaml https://api.meteroid.com/api-docs/openapi.json get /api/v1/webhooks/endpoints/{endpoint_id}
openapi: 3.1.0
info:
  title: meteroid
  description: ''
  license:
    name: LicenseRef-Proprietary
    identifier: LicenseRef-Proprietary
  version: 0.1.0
servers: []
security: []
tags:
  - name: Meteroid
    description: Meteroid API
  - name: Add-ons
  - name: Batch Jobs
  - name: Checkout Sessions
  - name: Connect
    description: Manage connected accounts (Express & Standard)
  - name: Coupons
  - name: Credit Notes
  - name: Custom Properties
  - name: Customers
  - name: Entitlements
  - name: Events
  - name: Features
  - name: Invoices
  - name: Metrics
  - name: OAuth
    description: OAuth 2.0 token endpoints (public, client-credentials auth)
  - name: OAuth Apps
    description: Manage OAuth applications for Connect integrations
  - name: Plans
  - name: Product Families
  - name: Products
  - name: Subscriptions
  - name: Usage
  - name: Webhook Endpoints
    description: Manage outbound webhook endpoints and inspect their deliveries
paths:
  /api/v1/webhooks/endpoints/{endpoint_id}:
    get:
      tags:
        - Webhook Endpoints
      summary: Get a webhook endpoint
      operationId: get_webhook_endpoint
      parameters:
        - name: endpoint_id
          in: path
          description: Webhook endpoint ID
          required: true
          schema:
            $ref: '#/components/schemas/WebhookEndpointId'
      responses:
        '200':
          description: Webhook endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '404':
          description: Webhook endpoint not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    WebhookEndpointId:
      type: string
      format: MeteroidId
      examples:
        - whe_7n42DGM5Tflk9n8mt7Fhc7
    WebhookEndpoint:
      type: object
      description: A destination Meteroid POSTs signed event payloads to.
      required:
        - id
        - url
        - event_types
        - disabled
        - consecutive_failures
        - max_in_flight
        - headers
        - needs_setup
        - created_at
      properties:
        consecutive_failures:
          type: integer
          format: int32
          description: Failures since the last success, reset to 0 on any 2xx.
        created_at:
          type: string
          format: date-time
        description:
          type:
            - string
            - 'null'
        disabled:
          type: boolean
        disabled_reason:
          oneOf:
            - $ref: '#/components/schemas/WebhookEndpointDisabledReason'
            - type: 'null'
        event_types:
          type: array
          items:
            type: string
          description: Subscribed event types. Empty means every event type.
        headers:
          type: array
          items:
            $ref: '#/components/schemas/WebhookHeader'
          description: Custom headers sent with every delivery.
        id:
          $ref: '#/components/schemas/WebhookEndpointId'
        last_failure_at:
          type:
            - string
            - 'null'
          format: date-time
        last_success_at:
          type:
            - string
            - 'null'
          format: date-time
        max_in_flight:
          type: integer
          format: int32
          description: >-
            How many deliveries this endpoint may have in flight at once.
            Read-only; it is

            set from the tenant's environment when the endpoint is created.
        needs_setup:
          type: boolean
          description: >-
            A sensitive header still waits for its value; the endpoint cannot be
            enabled

            until it is set.
        paused_until:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The endpoint was unreachable several times in a row: nothing is sent
            before

            this time, then it is retried one delivery at a time until it
            answers again.
        rate_limit_per_sec:
          type:
            - integer
            - 'null'
          format: int32
          description: Deliveries started per second, at most.
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        url:
          type: string
    RestErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
    WebhookEndpointDisabledReason:
      type: string
      enum:
        - MANUAL
        - AUTO_FAILURES
        - GONE
    WebhookHeader:
      type: object
      description: >-
        A custom header sent with every delivery. A sensitive header never
        returns its

        value; `set` says whether it has one.
      required:
        - name
        - sensitive
        - set
      properties:
        name:
          type: string
        sensitive:
          type: boolean
        set:
          type: boolean
        value:
          type:
            - string
            - 'null'
    ErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - NOT_FOUND
        - CONFLICT
        - FORBIDDEN
        - UNAUTHORIZED
        - TOKEN_EXPIRED
        - TOO_MANY_REQUESTS
        - INTERNAL_SERVER_ERROR
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````

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