웹 개발자는 보통 웹훅을 사용하여 다른 시스템에서 동작을 호출합니다. 예를 들어 웹훅을 사용하여 다음과 같은 작업을 수행할 수 있습니다.
관리자나 웹훅을 만들 수 있는 권한이 있는 사용자 지정 역할의 상담사여야 합니다. 평가판 계정은 최대 10개의 웹훅과 분당 60건의 호출 빈도 제한으로 제한됩니다.
웹훅에 대한 정보
Zendesk Support에서 웹훅을 활동에 연결하는 방법에는 두 가지가 있습니다.
- 하나 이상의 Zendesk 이벤트에 대한 웹훅을 구독합니다. 이 연결 방법을 사용하여 조직, 사용자, 상담사 대화 가능 여부, 헬프 센터 또는 커뮤니티 활동에 따라 요청을 보냅니다. 지원되는 이벤트 유형 목록은 API 참고자료에서 웹훅 이벤트 유형을 참조하세요.
- 웹훅을 트리거 또는 자동화에 연결합니다. 이 연결 방법을 사용하여 티켓 활동에 따라 요청을 보냅니다.
Zendesk 이벤트를 구독하는 웹훅은 트리거 또는 자동화에 연결할 수 없습니다. 마찬가지로 트리거 또는 자동화에 연결된 웹훅은 Zendesk 이벤트를 구독할 수 없습니다. 기존 웹훅의 연결 방법을 변경할 수 없습니다.
Zendesk 이벤트 구독하기
하나 이상의 Zendesk 이벤트를 구독하는 웹훅은 항상 POST HTTP 방법을 사용하여 요청을 보냅니다. 요청에는 이벤트 데이터가 들어 있는 JSON 페이로드가 포함됩니다. 요청에 대한 HTTP 방법이나 페이로드를 변경할 수 없습니다. 이벤트 페이로드 스키마에 대한 자세한 내용은 API 참고자료에서 웹훅 이벤트 유형을 참조하세요.
트리거 또는 자동화에 연결하기
-
JSON
-
XML
-
양식 인코딩된 콘텐츠
웹훅을 트리거 또는 자동화에 연결할 때 요청의 콘텐츠를 정의합니다. JSON 또는 XML 요청 형식과 함께 POST, PUT 또는 PATCH HTTP 방법을 사용하는 웹훅의 경우에는 콘텐츠가 요청 페이로드입니다. 다른 HTTP 방법이나 형식을 사용하는 웹훅에는 요청 페이로드가 포함되지 않습니다. 대신 두 개의 키-값 문자열 배열로 사용자 지정 URL 매개 변수를 추가할 수 있습니다. 요청 페이로드 또는 URL 매개 변수를 정의할 때 사용 가능한 콘텐츠 자리 표시자를 사용하여 요청에 티켓 데이터를 삽입할 수 있습니다.
웹훅의 요청 페이로드 또는 URL 매개변수는 256KB 미만이어야 합니다.
웹훅 순서 정렬 및 재시도
이벤트, 트리거 또는 자동화가 웹훅을 호출할 때 실행될 웹훅 작업이 대기열에 쌓이지만 실제로는 바로 작업을 실행하지 않습니다. 웹훅 작업은 별개로 실행되므로 웹훅이 특정 순서로 실행된다는 보장은 없습니다.
엔드포인트가 특정 HTTP 응답 코드를 리턴하는 경우 웹훅 요청은 최대 3번까지 자동으로 다시 시도됩니다. 대상과 달리 연속된 실패 요청이 웹훅을 비활성화하지 않습니다. 자세한 내용과 재시도 시나리오의 예는 개발자 문서에서 웹훅 모니터링하기를 참조하세요.
웹훅 만들기
관리 센터에서 웹훅을 만들 수 있습니다.
웹훅을 만들려면 다음과 같이 하세요.
- 관리 센터의 사이드바에서
앱 및 연동 서비스를 클릭한 다음 작업 및 웹훅 > 웹훅을 선택합니다. -
웹훅 만들기를 클릭합니다.
- 웹훅을 하나 이상의 Zendesk 이벤트에 구독하려면 Zendesk 이벤트를 선택하고 드롭다운에서 하나 이상의 이벤트 유형을 선택합니다.
- 웹훅을 트리거 또는 자동화에 연결하려면 트리거 또는 자동화를 선택합니다.
- 다음을 클릭합니다.
- 웹훅의 이름과 설명을 입력합니다.
- 타사 서비스나 시스템과 연동하는 데 사용되는 엔드포인트 URL을 입력합니다. 웹훅 엔드포인트를 참조하세요.
타사와 연동하기 위해 웹훅을 설정할 때에는 해당 타사 문서를 참조해야 할 수도 있습니다.
- 웹훅의 요청 방법 및 요청 형식을 선택합니다.
- 웹훅의 인증 방법을 선택하고 필요한 모든 추가 정보를 제공합니다. 웹훅 인증하기를 참조하세요.
- (선택 사항) 헤더 추가를 클릭하여 사용자 지정 헤더를 추가한 다음 헤더 이름과 값을 입력합니다. 최대 4개의 헤더를 더 추가하려면 다른 헤더 추가를 클릭합니다. 사용자 지정 웹훅 헤더를 참조하세요.참고: 사용자 지정 헤더에 민감한 정보를 넣지 마세요.
- (선택 사항) 웹훅 테스트를 클릭하여 예상대로 제대로 작동하는지 확인합니다.
- 웹훅 만들기를 클릭하여 웹훅을 만듭니다.
- 트리거 및 자동화 웹훅의 경우에는 웹훅을 트리거 또는 자동화에 연결해야 합니다. 웹훅을 Support 트리거 또는 자동화에 연결하기를 참조하세요. 트리거 또는 자동화를 연결한 후 웹훅 만들기 페이지로 돌아가서 설정 마침을 클릭합니다.
웹훅을 만든 후에는 관리 센터의 웹훅 페이지에서 웹훅의 세부 정보, 구독 및 활동을 볼 수 있습니다. 웹훅 관리하기를 참조하세요.
웹훅 엔드포인트
웹훅은 웹훅을 만들 때 지정한 엔드포인트 URL로 요청을 보냅니다. 엔드포인트 URL은 https://www.yourdomain.com/path 형식을 사용합니다.
필수는 아니지만 보안 HTTP (HTTPS)를 사용할 것을 권장합니다. 보안 엔드포인트 URL을 제공함으로써 인증을 사용 설정하고 데이터를 안전하게 전달할 수 있습니다.
사용자 지정 웹훅 헤더
사용자 지정 헤더는 웹훅이 보내는 요청에 추가 정보를 포함하는 방법을 제공하며 고유한 웹훅 헤더 요구 사항이 있는 일부 타사 서비스에 더 쉽게 연결할 수 있게 합니다. 사용자 지정 헤더에 다음과 같은 요구 사항 및 제한 사항이 있습니다.
- 사용자 지정 헤더를 사용하려면 보안 (HTTPS) 엔드포인트 URL을 사용해야 합니다.
- 사용자 지정 헤더에 인증 자격 증명이나 기타 민감한 정보를 포함하지 마세요. 대신 지원되는 인증 방법을 사용하세요.
- 헤더 이름은 고유해야 하며 128자를 초과할 수 없습니다. 모든 영숫자 US ASCII 문자와
!,#,$,%,&,',*,+,-,.,^,_,`,|및~기호가 지원됩니다. - 헤더 값의 길이는 최대 1,000자까지 가능하며 0x20부터 0x7E까지의 모든 US ASCII 문자를 지원합니다.
- 다음 헤더는 지원되지 않습니다.
- accept-charset
- accept-encoding
- connection
- content-encoding
- content-length
- content-md5
- content-type
- date
- expect
- forwarded
- host
- keep-alive
- max-forwards
- origin
- proxy-authenticate
- referer
- server
- te
- trailer
- transfer-encoding
- upgrade
- user-agent
- via
- www-authenticate
- zendesk-api-version
- zendesk-ep
- 또한 헤더는 다음과 같은 접두부로 시작할 수 없습니다.
- access-control
- x-amzn
- x-apigw
- x-datadog
- x-envoy
- x-forwarded
- x-zendesk
웹훅 인증하기
웹훅이 보안 엔드포인트와 연동되는 경우에는 웹훅과 웹훅이 보내는 데이터를 인증하기 위한 3가지 옵션이 있습니다. 엔드포인트의 인증 요구 사항에 관한 타사 문서를 참조하거나 팀의 개발자와 함께 웹훅의 올바른 인증 방법을 결정할 수 있습니다.
- 필요 없음: 인증이 구성되어 있지 않거나 필요하지 않습니다.
- API 키: API 키를 사용하여 웹훅을 인증합니다.
- 기본 인증: 사용자 이름 및 비밀번호를 사용하여 웹훅을 인증합니다.
- 무기명 토큰: OAuth 액세스 토큰을 사용하여 웹훅을 인증합니다.
개발자가 웹훅 인증에 대한 자세한 정보를 원하는 경우에는 웹훅 보안 및 인증을 참조하세요.
한층 더 강화된 보안을 위해 웹훅의 서명을 확인할 수도 있습니다. 자세한 내용은 웹훅 신뢰성 확인하기를 참조하세요.
웹훅을 트리거 또는 자동화에 연결하기
트리거 및 자동화 웹훅을 호출하려면 먼저 웹훅을 트리거 또는 자동화에 연결해야 합니다. 트리거와 자동화는 웹훅이 호출되어야 하는 상황을 지정합니다.
Support 트리거에 웹훅을 연결하려면 다음과 같이 하세요.
- 관리 센터의 사이드바에서
개체 및 규칙을 클릭한 다음 비즈니스 규칙 > 트리거를 선택합니다. -
새 트리거를 만들거나 옵션 아이콘(
)에 커서를 갖다 대고 편집을 클릭하여 기존 트리거를 편집합니다. - 작업 아래에서 작업 추가를 클릭합니다. 웹훅에 알림을 선택한 다음 해당 웹훅을 선택합니다.
- 웹훅의 요청 형식에 따라 웹훅의 요청 페이로드나 URL 매개변수를 입력합니다. 페이로드나 매개변수는 256KB 미만이어야 합니다.
- 저장을 클릭합니다.
- 관리 센터의 사이드바에서 개체 및 규칙을 클릭한 다음 비즈니스 규칙 > 자동화를 선택합니다.
-
새 자동화를 만들거나 옵션 아이콘()에 커서를 갖다 대고 편집을 클릭하여 기존 자동화를 편집합니다.
-
다음 작업 수행 아래에서 작업 추가 아이콘(
)을 클릭합니다. 알림: 웹훅에 알림을 선택한 다음 해당 웹훅을 선택합니다. - 웹훅의 요청 형식에 따라 웹훅의 요청 페이로드나 URL 매개변수를 입력합니다. 페이로드나 매개변수는 256KB 미만이어야 합니다.
- 제출을 클릭합니다.
웹훅 테스트하기
관리 센터에 요청은 물론 서로 다른 이벤트 소스와 웹훅을 테스트하는 옵션이 있습니다. 특히 테스트를 위해 기존 웹훅에 액세스하는 것 외에도 웹훅을 만들거나 편집하는 동안 테스트할 수도 있습니다.
웹훅을 테스트하려면 다음과 같이 하세요.
- 관리 센터의 사이드바에서 앱 및 연동 서비스를 클릭한 다음 작업 및 웹훅 > 웹훅을 선택합니다.
- 목록에서 웹훅을 찾아 웹훅 행에 있는 옵션 메뉴 아이콘()을 클릭한 다음 웹훅 테스트를 클릭합니다.
- 웹훅 테스트 창에서 테스트할 이벤트를 선택합니다. 엔드포인트 URL을 테스트하는 데 사용할 수 있는 샘플 요청입니다.
- 테스트 요청의 세부 정보(요청 본문, 매개변수 또는 헤더)를 입력합니다.
- 테스트 보내기를 클릭합니다. 테스트 요청 아래 창에 응답이 표시됩니다.
댓글 81개
Jacob the Moderator
Very exciting stuff!
Testing this I was expecting to see an event in the ticket event log, for tickets where a trigger ran a webhook action, but it isn't. Is this deliberate?
0
댓글을 남기려면 로그인하세요.