---
title: "웹훅 생성"
method: POST
path: "/webhooks"
tags: ["USER API"]
---

# 웹훅 생성

`POST /webhooks`

요청받은 웹훅 정보로 워크스페이스 웹훅을 생성합니다. 워크스페이스 웹훅은 워크스페이스내 모든 멤버를 대상으로 이벤트 설정에 따른 웹훅 전송 설정이 가능 합니다.

## Request body

- CreateWebhookRequestDto
  - `name` string, required — 웹훅 명칭(사용자가 구분하기 쉽도록)
  - `url` string, required — 웹훅 이벤트를 전달받을 URL (POST Method 로 요청 됩니다)
  - `headers` CreateWebhookRequestHeaderDto[] — 웹훅 헤더 설정 정보
    - `key` string, required — 웹훅 헤더 키
    - `value` string, required — 웹훅 헤더 값
  - `events` string[] — 활성화 하려는 웹훅 구독 이벤트 타입 이벤트 종류: * `document_started`: 새로운 문서로 서명 요청이 시작됨 * `document_signed`: 서명자가 문서에 서명을 입력함 (마지막 서명자의 서명 시에는 발행되지 않습니다.) * `document_all_signed`: 문서의 모든 서명자가 서명함 (마지막 서명자가 서명한 후 발행됩니다.) * `document_rejected`: 서명자가 문서에 서명을 거절함 * `document_request_canceled`: 문서의 서명 요청이 취소됨 * `document_signing_canceled`: 서명자가 입력한 서명을 취소함

## Response `201`

- CreateWebhookResponseDto
  - `id` string, required — 웹훅 아이디
  - `name` string, required — 사용자가 지정한 웹훅 이름
  - `url` string, required — 웹훅 URL
  - `createdAt` string, date-time, required — 웹훅 생성일
  - `updatedAt` string, date-time, required — 웹훅 갱신일
  - `headers` WebhookHeaderResponseDto[], required — 웹훅 헤더 설정 정보
    - `key` string, required — 웹훅 헤더 키
    - `value` string, required — 웹훅 헤더 값
  - `events` string[], required — 웹훅 구독 이벤트 설정 정보

---

[API](https://skmtc.net/modusign/apis/modusign-api.md) · [All operations](https://skmtc.net/modusign/apis/modusign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modusign/modusign-api/versions/5772e872cbf9/schema)