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

# 웹훅 시험 이벤트 발행

> 선택한 엔드포인트에 webhook_test를 발송 대기 상태로 만든다. 수신 여부는 전송 기록에서 확인한다.



## OpenAPI

````yaml https://raw.githubusercontent.com/asm17-ms2/meterengine/main/backend/openapi.yaml post /v1/webhook-endpoints/{id}/test-events
openapi: 3.1.0
info:
  description: |
    사용량 기반 과금 플랫폼의 API. 사용량 이벤트를 수집하고, 고객별 월 사용량과 청구 예정액을 조회한다.

    요청마다 Authorization 헤더에 Bearer 값으로 API 키(me_live_ 또는 me_test_로 시작)나
    로그인 세션 토큰을 싣는다. 도입사는 키나 세션이 정한다. 헤더가 없으면 401이다.

    X-MeterEngine-Environment: test 또는 live로 업무 환경을 지정한다. 새 키는 발급 환경에 고정된다.
    기존 데이터와 키는 환경 미지정 범위로 보존하며 자동으로 test/live에 배정하지 않는다.
    환경 분리가 지원되지 않는 업무는 명시 환경 요청에 409를 반환한다.
    X-MeterEngine-Organization-Id: 화면의 도입사를 고정하는 선택 UUID 헤더다.
    인증된 도입사와 다르면 403이며 이 헤더로 인증이나 도입사 전환을 대신할 수 없다.

    오류 응답은 code, message, errors로 이뤄진다. 오류별 처리는 code로 분기한다. message는
    code마다 하나인 한국어 문구이고, errors는 틀린 필드를 짚을 수 있는 400에만 실린다.
  title: MeterEngine API
  version: v1
servers:
  - description: MeterEngine API
    url: https://meterengine.com
security:
  - bearerAuth: []
tags:
  - name: organization-environment-controller
    x-group: 업무 환경
  - name: current-organization-controller
    x-group: 도입사 정보
  - name: api-key-controller
    x-group: API 키 (콘솔 전용)
  - name: organization-people-controller
    x-group: 구성원과 초대 (콘솔 전용)
  - name: audit-log-controller
    x-group: 감사 기록 (콘솔 전용)
  - name: billable-metric-controller
    x-group: 미터
  - name: billable-metric-price-controller
    x-group: 미터별 단가 조회
  - name: price-rate-controller
    x-group: 단가
  - name: price-plan-controller
    x-group: 요금제
  - name: customer-controller
    x-group: 고객
  - name: event-controller
    x-group: 이벤트
  - name: event-batch-controller
    x-group: 이벤트 일괄 전송
  - name: event-export-controller
    x-group: 이벤트 내보내기
  - name: billable-metric-usage-controller
    x-group: 사용량 집계
  - name: event-issue-controller
    x-group: 이벤트 매핑 진단
  - name: event-rejection-controller
    x-group: 수집 거절
  - name: unbilled-event-controller
    x-group: 청구 제외 사용량
  - name: dashboard-controller
    x-group: 개요
  - name: workspace-query-controller
    x-group: 검색과 내보내기
  - name: draft-invoice-controller
    x-group: 청구 예정액
  - name: invoice-controller
    x-group: 인보이스
  - name: invoice-view-link-controller
    x-group: 인보이스 조회 링크
  - name: payment-setting-controller
    x-group: 결제 설정
  - name: toss-payments-credential-controller
    x-group: 토스페이먼츠 키
  - name: payment-method-registration-controller
    x-group: 카드 등록 링크
  - name: payment-method-controller
    x-group: 결제 수단
  - name: payment-attempt-controller
    x-group: 결제 요청
  - name: invoice-payment-controller
    x-group: 수납 상태
  - name: payment-cancellation-controller
    x-group: 결제 취소
  - name: payment-reconciliation-mismatch-controller
    x-group: 대사 불일치
  - name: toss-payments-webhook-controller
    x-group: 토스페이먼츠 웹훅 수신
  - name: webhook-endpoint-controller
    x-group: 웹훅
paths:
  /v1/webhook-endpoints/{id}/test-events:
    post:
      tags:
        - webhook-endpoint-controller
      summary: 웹훅 시험 이벤트 발행
      description: 선택한 엔드포인트에 webhook_test를 발송 대기 상태로 만든다. 수신 여부는 전송 기록에서 확인한다.
      operationId: testWebhookEndpoint
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '202':
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: string
                  format: uuid
          description: Accepted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: |
            code=authentication_required: Authorization 헤더가 없다.
            code=invalid_credentials: 키나 토큰의 형식이 틀렸거나, 모르는 값이거나, 폐기 또는 만료됐다.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >
            code=permission_denied: 키의 스코프나 계정의 역할로는 할 수 없는 요청이거나, 도입사가 정해지지 않은
            로그인 세션이다.

            code=organization_not_active: 도입사가 활성 상태가 아니다.

            code=consent_required: 로그인 세션의 사용자가 필수 안내에 아직 동의하지 않았다. POST
            /v1/sessions/current/consents로 동의한다.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            code=rate_limit_exceeded: 키의 분당 요청 한도를 넘었다. Retry-After 헤더의 초만큼 기다린
            뒤 다시 보낸다.
          headers:
            Retry-After:
              description: 다시 보내기 전에 기다릴 초
              required: true
              schema:
                type: integer
                format: int32
components:
  schemas:
    ErrorResponse:
      type: object
      description: 오류 응답. code로 오류 종류를 구분하고, message는 code마다 하나인 한국어 문구다.
      properties:
        code:
          type: string
          description: 오류 종류. 오류별 처리는 이 값으로 분기한다.
          enum:
            - validation_error
            - malformed_request_body
            - invalid_billable_metric
            - invalid_price_rate
            - event_too_old
            - invalid_toss_payments_credential
            - payment_method_rejected
            - toss_payments_test_code_in_live_mode
            - invalid_webhook_url
            - invalid_webhook_event_type
            - authentication_required
            - invalid_credentials
            - permission_denied
            - organization_not_active
            - environment_mismatch
            - consent_required
            - customer_not_found
            - event_not_found
            - billable_metric_not_found
            - price_rate_not_found
            - invoice_not_found
            - invoice_view_link_not_found
            - endpoint_not_found
            - api_key_not_found
            - organization_not_found
            - user_account_not_found
            - payment_method_not_found
            - payment_method_registration_not_found
            - payment_attempt_not_found
            - toss_payments_credential_not_found
            - price_plan_not_found
            - webhook_endpoint_not_found
            - webhook_delivery_not_found
            - invitation_not_found
            - method_not_allowed
            - response_type_not_acceptable
            - resource_version_conflict
            - idempotency_conflict
            - customer_archived
            - resource_archived
            - environment_not_ready
            - archive_restoration_conflict
            - customer_has_events
            - customer_has_payment_attempts
            - billable_metric_has_events
            - billable_metric_has_price_rate
            - billable_metric_already_exists
            - billable_metric_event_type_target_property_already_exists
            - invoice_already_paid
            - payment_result_unconfirmed
            - payment_retry_unavailable
            - payment_retry_stale
            - invoice_amount_zero
            - email_already_exists
            - organization_status_transition_invalid
            - organization_member_already_exists
            - toss_payments_credential_missing
            - payment_method_missing
            - payment_mode_mismatch
            - payment_attempt_not_cancelable
            - payment_attempt_fully_canceled
            - payment_cancellation_amount_exceeded
            - payment_cancellation_in_progress
            - payment_cancellation_idempotency_conflict
            - webhook_delivery_not_retryable
            - price_rate_history_immutable
            - price_plan_history_immutable
            - webhook_endpoint_disabled
            - webhook_endpoint_limit_exceeded
            - invitation_unavailable
            - last_owner_required
            - owner_scopes_required
            - last_operator_required
            - api_key_unavailable
            - upload_size_exceeded
            - request_type_not_supported
            - rate_limit_exceeded
            - internal_server_error
            - request_timed_out
            - toss_payments_unavailable
        errors:
          type: array
          description: 틀린 필드 목록. 400 응답에만 실린다.
          items:
            $ref: '#/components/schemas/FieldError'
        message:
          type: string
          description: code마다 하나인 한국어 문구. 예고 없이 바뀔 수 있으니 분기에 쓰지 않는다.
          example: 서버 내부 오류입니다
      required:
        - code
        - message
    FieldError:
      type: object
      description: 틀린 필드 하나
      properties:
        field:
          type: string
          description: 틀린 값을 보낸 자리의 이름. 요청에 쓴 이름과 같다.
          example: event_type
        message:
          type: string
          description: 이 자리의 값이 거절된 이유.
          example: 공백일 수 없습니다
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

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