---
updatedAt: 2026-04-22T09:48:12.000Z
agentTools:
  projectIndex: https://developers.modusign.co.kr/llms.txt
---

# 웹훅 생성

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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/webhooks": {
      "post": {
        "description": "요청받은 웹훅 정보로 워크스페이스 웹훅을 생성합니다. 워크스페이스 웹훅은 워크스페이스내 모든 멤버를 대상으로 이벤트 설정에 따른 웹훅 전송 설정이 가능 합니다.",
        "operationId": "UserController_createWebhook",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateWebhookRequestDto"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateWebhookResponseDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "Basic": []
          },
          {
            "Bearer": []
          }
        ],
        "summary": "웹훅 생성",
        "tags": [
          "USER API"
        ]
      }
    }
  },
  "info": {
    "title": "MODUSIGN API",
    "description": "",
    "version": "1.0.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.modusign.co.kr",
      "description": "production"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "Basic": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "CreateWebhookRequestHeaderDto": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "웹훅 헤더 키"
          },
          "value": {
            "type": "string",
            "description": "웹훅 헤더 값"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "CreateWebhookRequestDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "웹훅 명칭(사용자가 구분하기 쉽도록)",
            "minLength": 1,
            "maxLength": 100
          },
          "url": {
            "type": "string",
            "description": "웹훅 이벤트를 전달받을 URL (POST Method 로 요청 됩니다)"
          },
          "headers": {
            "description": "웹훅 헤더 설정 정보",
            "default": [],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateWebhookRequestHeaderDto"
            }
          },
          "events": {
            "type": "array",
            "description": "활성화 하려는 웹훅 구독 이벤트 타입\n\n이벤트 종류:\n* `document_started`: 새로운 문서로 서명 요청이 시작됨\n* `document_signed`: 서명자가 문서에 서명을 입력함 (마지막 서명자의 서명 시에는 발행되지 않습니다.)\n* `document_all_signed`: 문서의 모든 서명자가 서명함 (마지막 서명자가 서명한 후 발행됩니다.)\n* `document_rejected`: 서명자가 문서에 서명을 거절함\n* `document_request_canceled`: 문서의 서명 요청이 취소됨\n* `document_signing_canceled`: 서명자가 입력한 서명을 취소함\n* `document_modification_started`: 요청자가 문서 내용 수정을 시작함\n* `document_modification_completed`: 요청자가 문서 내용 수정을 완료함\n* `document_modification_canceled`: 요청자가 문서 내용 수정을 취소함\n* `document_modification_approval_requested`: 문서 내용 수정 완료 후 내부결재가 요청됨",
            "items": {
              "type": "string",
              "enum": [
                "",
                "document_request_canceled",
                "document_signing_canceled",
                "document_all_signed",
                "document_started",
                "document_signed",
                "document_rejected",
                "document_modification_started",
                "document_modification_completed",
                "document_modification_canceled",
                "document_modification_approval_requested"
              ]
            }
          }
        },
        "required": [
          "name",
          "url"
        ]
      },
      "WebhookHeaderResponseDto": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "웹훅 헤더 키"
          },
          "value": {
            "type": "string",
            "description": "웹훅 헤더 값"
          }
        },
        "required": [
          "key",
          "value"
        ]
      },
      "CreateWebhookResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "웹훅 아이디"
          },
          "name": {
            "type": "string",
            "description": "사용자가 지정한 웹훅 이름"
          },
          "url": {
            "type": "string",
            "description": "웹훅 URL"
          },
          "createdAt": {
            "format": "date-time",
            "type": "string",
            "description": "웹훅 생성일"
          },
          "updatedAt": {
            "format": "date-time",
            "type": "string",
            "description": "웹훅 갱신일"
          },
          "headers": {
            "description": "웹훅 헤더 설정 정보",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookHeaderResponseDto"
            }
          },
          "events": {
            "type": "array",
            "description": "웹훅 구독 이벤트 설정 정보",
            "items": {
              "type": "string",
              "enum": [
                "document_request_canceled",
                "document_signing_canceled",
                "document_all_signed",
                "document_started",
                "document_signed",
                "document_rejected",
                "document_modification_started",
                "document_modification_completed",
                "document_modification_canceled",
                "document_modification_approval_requested"
              ]
            }
          }
        },
        "required": [
          "id",
          "name",
          "url",
          "createdAt",
          "updatedAt",
          "headers",
          "events"
        ]
      }
    }
  }
}
```