알림 웹훅 생성하기

온라인에서 편집하기

알림 웹훅은 특정 이벤트가 발생했을 때 제3자에게 데이터를 전송하기 위해 사용하는 외부 API 호출입니다.

이 태스크에 대한 정보

시작하려는 외부 API의 요청 URL( URL )을 구성하고, 요청을 시작하는 데 필요한 헤더나 매개변수를 추가할 수 있습니다( URL ). 이벤트 페이로드에 대한 자세한 내용은 ‘이벤트 유형 및 페이로드’를 참조하십시오.

웹훅 구성 JSON 내에 속성이 notification 있습니다. 이 특성은 모든 알림 특정 구성 옵션을 포함하는 중첩된 JSON 오브젝트입니다. interests 특성은 이 notification 오브젝트 내에 정의됩니다. 이벤트가 발생하면 interests 특성의 각 요소에 대해 검사됩니다. 속성 interests 내의 요소 중 하나라도 일치하는 것으로 판정되면, 해당 이벤트가 웹훅 수신처로 전송됩니다. 관심사는 순서대로 확인되므로, 고성능이 요구되는 사용 사례에서는 가장 광범위한 일치 조건을 맨 앞에 배치하십시오.

관심사는 name 및 clauses 목록의 두 필드로 구성됩니다. 이 조항들은 해당 이자가 조건에 부합하는지 여부를 결정합니다. 각 절은 연산자로 AND 연결되며, 모든 절이 조건에 부합할 때만 조건이 충족됩니다. 절은 다음과 같은 세 개의 필드로 구성됩니다.

  • key
  • value
  • excludeoperation - 유효한 값은 및 입니다 include .
키(key)는 JSON 속성 이름이며, 이 절이 일치하는지 여부를 판단할 때 이벤트 내의 어느 지점을 가리키는지를 나타내는 데 사용됩니다. 이 키는 최상위 키나 이벤트의 데이터 객체 내 키를 평가하는 데 사용할 수 있습니다. 데이터 객체를 참조할 때는 JSON 점 표기법이 사용됩니다. 예를 들어 data.action. 이 값은 검사 중인 필드의 기대값입니다. 이 연산자는 해당 절에 대한 일치 여부에 따라 이벤트가 포함될지 제외될지를 나타냅니다.

예를 들어, 인증 이벤트가 주요 관심사이지만 페더레이션을 통해 이루어지는 인증은 제외하고자 할 경우, 다음 절을 사용하십시오:

  • Key: event_type, Value: authentication, Operation: include
  • Key: data.subtype, Value: federation, Operation: exclude

이 절들은 다음과 같은 논리 평가로 변환됩니다:

federationevent_type ~이다 authentication 그리고 data.subtype ~가 아니다.

자세한 내용은 알림 웹훅을 참조하세요.

프로시저

  1. ‘통합’ > ‘알림 웹훅 ’으로 이동합니다.
  2. ‘웹훅 생성’을 클릭하세요.
  3. 웹훅의 이름을 제공하십시오.
    소유자 및 이메일 연락처 정보를 지정할 수도 있습니다.
  4. API에 대한 하나 이상의 요청 URL을 지정하십시오.
  5. 인증의 유형을 선택하십시오.
    기본
    사용자 이름 및 비밀번호를 지정하십시오.
    헤더
    헤더 이름 및 인증 시크릿을 지정하십시오. 시크릿이 대소문자를 구분하는 경우 대소문자 구분 선택란을 선택하십시오.
    없음
    인증 정보가 필요하지 않습니다.
    OAuth
    토큰 엔드포인트를 지정하고 클라이언트 시크릿이 POST 또는 기본인지 선택한 후 클라이언트 ID 및 비밀번호를 입력하십시오.
    참고: 클라이언트 게시물에 따르면 비밀번호는 속성으로 저장되어 있습니다. 클라이언트 기본은 시크릿이 헤더에 저장됨을 표시합니다.
    JSON 웹 토큰(JWT)
    HTTP 헤더 값, 서브 클레임, JWT의 최대 유효 기간 및 서명 알고리즘을 지정하십시오. 원하신다면 JWT 헤더 값 접두사, JWT 헤더 키 및 클레임 이름을 지정할 수도 있습니다.
    뮤추얼 TLS ( mTLS )
    MTLS 인증서 레이블을 지정하십시오.
  6. 선택 사항: 사용자 지정 헤더와 값을 입력하세요.
  7. 선택 사항: 데드 레터 기능을 활성화합니다.
    ‘미배달 메일’ 항목에는 전송에 실패한 알림 기록이 표시됩니다.
    1. ‘미배달 메일 조정 자동 시도’를 활성화하고 조정 시도 간격을 선택합니다.
      알림을 5분, 15분 또는 30분 간격으로 다시 보내도록 설정할 수 있습니다.
  8. 다음을 클릭하십시오.
  9. 웹훅에 대한 이벤트 구독을 지정하세요.
    지정한 이벤트 중 하나가 발생하면 웹훅에 대한 알림이 전송됩니다. 사전 정의된 이벤트를 선택하거나 사용자 지정 이벤트를 추가하세요. 이벤트를 하나 이상 지정해야 합니다.
  10. 선택 사항: ‘사전 정의된 이벤트’를 클릭합니다.
    1. 사전 정의된 이벤트 중 하나 이상의 확인란을 선택하십시오.
      • 모든 인증 이벤트
      • 실패한 인증 이벤트
      • 사용자 프로파일 수정 완료
      • 사용자 프로파일이 작성됨
      선택한 이벤트는 ‘선택된 이벤트 ’의 세부 정보 창에 나열됩니다.
    2. ‘추가’를 클릭하세요.
      이벤트 구독 페이지로 돌아가면 이벤트가 ‘이벤트 구성’ 섹션에 나열됩니다.
  11. 선택 사항: ‘사용자 지정 이벤트 추가’를 클릭합니다.
    1. 이벤트 이름을 입력하세요.
      이벤트에 대한 설명을 입력할 수도 있습니다.
    2. 이벤트를 발생시키는 관심사를 지정하십시오.
      이벤트는 속성과 값의 쌍으로, 이벤트를 트리거하려면 이 값이 true로 평가되어야 합니다.
    3. 이자를 포함할지 제외할지 지정하십시오.
      관리자가 아닌 사용자의 모든 인증 이벤트에 대해 웹훅이 실행되도록 하려면 `include`와 user.type admin `exclude`를 지정할 event_type authentication 수 있습니다.
    4. 선택 사항: 관심사를 더 추가해 주세요.
  12. ‘추가’를 클릭하세요.
    이벤트 구독 페이지로 돌아가면, 해당 이벤트가 ‘이벤트 구성’ 섹션에 표시됩니다.
  13. 선택 사항: 사용자 지정 이벤트를 더 추가하세요.
  14. ‘만들기’를 클릭하세요.
    웹훅이 ‘알림 웹훅’ 페이지에 나열되어 있으며, 해당 웹훅이 표시됩니다.
  15. 선택 사항: 웹훅의 이벤트를 수정합니다.
    1. 사용자 지정 이벤트와 사전 정의된 이벤트를 더 추가하세요.
    2. 이벤트 편집
      1. 편집 아이콘수정하려는 항목을 선택한 다음 연필 아이콘을 클릭하세요.
      2. 이름이나 설명을 변경할 수 있습니다. 관심사를 추가하거나 수정할 수 있습니다.
      3. ‘업데이트’를 클릭하세요.
    3. 원 안에 있는 뺄셈 기호이벤트를 삭제하려면 해당 이벤트를 선택한 다음 ‘삭제’ 아이콘을 클릭하세요.
  16. 선택 사항: 연결 정보를 수정합니다.
    1. ‘연결 정보’를 선택하세요.
    2. ‘ 목적’과 ‘통합 버전 ’을 제외한 모든 설정을 수정하십시오.
    3. 연결을 테스트하십시오.
    4. 건강 상태를 확인하세요.
    5. 웹훅을 삭제하세요.
  17. 변경 사항이 있다면 ‘변경 사항 저장’을 클릭하세요.
  18. ‘알림 웹훅’을 클릭하면 알림 웹훅 페이지로 돌아갑니다.