WebHookActivity interface
WebHook 작업입니다.
- Extends
속성
| authentication | 엔드포인트를 호출하는 데 사용되는 인증 방법입니다. |
| body | 엔드포인트로 전송될 페이로드를 나타냅니다. POST/PUT 메서드에 필요하며 GET 메서드 Type: string(또는 resultType 문자열이 있는 식)에는 허용되지 않습니다. |
| headers | 요청에 보낼 헤더를 나타냅니다. 예를 들어 요청에 언어 및 형식을 설정하려면 다음을 수행합니다. "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. 형식: 문자열(또는 resultType 문자열이 있는 식). |
| method | 대상 엔드포인트에 대한 Rest API 메서드입니다. |
| report |
true로 설정하면 콜백 요청 본문의 statusCode, 출력 및 오류가 활동에 의해 사용됩니다. 콜백 요청에서 statusCode >= 400을 설정하여 활동을 실패로 표시할 수 있습니다. 기본값은 false입니다. 형식: 부울(또는 resultType 부울이 있는 식). |
| timeout | 웹후크를 다시 호출해야 하는 시간 제한입니다. 지정된 값이 없으면 기본값은 10분입니다. 형식: 문자열입니다. 패턴: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])). |
| type | 이 개체가 될 수 있는 다양한 형식을 지정하는 다형 판별자 |
| url | WebHook 작업 대상 엔드포인트 및 경로입니다. 형식: 문자열(또는 resultType 문자열이 있는 식). |
상속된 속성
| depends |
활동은 조건에 따라 달라집니다. |
| description | 활동 설명입니다. |
| name | 활동 이름입니다. |
| on |
상태가 비활성 상태로 설정된 경우 활동의 상태 결과입니다. 이 속성은 선택적 속성이며 활동이 비활성 상태일 때 제공되지 않으면 기본적으로 상태가 성공합니다. |
| state | 작업 상태입니다. 선택적 속성이며 제공되지 않으면 기본적으로 상태가 활성 상태가 됩니다. |
| user |
활동 사용자 속성입니다. |
속성 세부 정보
authentication
엔드포인트를 호출하는 데 사용되는 인증 방법입니다.
authentication?: WebActivityAuthentication
속성 값
body
엔드포인트로 전송될 페이로드를 나타냅니다. POST/PUT 메서드에 필요하며 GET 메서드 Type: string(또는 resultType 문자열이 있는 식)에는 허용되지 않습니다.
body?: any
속성 값
any
headers
요청에 보낼 헤더를 나타냅니다. 예를 들어 요청에 언어 및 형식을 설정하려면 다음을 수행합니다. "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. 형식: 문자열(또는 resultType 문자열이 있는 식).
headers?: any
속성 값
any
method
대상 엔드포인트에 대한 Rest API 메서드입니다.
method: string
속성 값
string
reportStatusOnCallBack
true로 설정하면 콜백 요청 본문의 statusCode, 출력 및 오류가 활동에 의해 사용됩니다. 콜백 요청에서 statusCode >= 400을 설정하여 활동을 실패로 표시할 수 있습니다. 기본값은 false입니다. 형식: 부울(또는 resultType 부울이 있는 식).
reportStatusOnCallBack?: any
속성 값
any
timeout
웹후크를 다시 호출해야 하는 시간 제한입니다. 지정된 값이 없으면 기본값은 10분입니다. 형식: 문자열입니다. 패턴: ((\d+).)? (\d\d):(60|( [0-5] [0-9])):(60|( [0-5] [0-9])).
timeout?: string
속성 값
string
type
이 개체가 될 수 있는 다양한 형식을 지정하는 다형 판별자
type: "WebHook"
속성 값
"WebHook"
url
WebHook 작업 대상 엔드포인트 및 경로입니다. 형식: 문자열(또는 resultType 문자열이 있는 식).
url: any
속성 값
any
상속된 속성 세부 정보
dependsOn
활동은 조건에 따라 달라집니다.
dependsOn?: ActivityDependency[]
속성 값
description
name
onInactiveMarkAs
상태가 비활성 상태로 설정된 경우 활동의 상태 결과입니다. 이 속성은 선택적 속성이며 활동이 비활성 상태일 때 제공되지 않으면 기본적으로 상태가 성공합니다.
onInactiveMarkAs?: string
속성 값
string
state
작업 상태입니다. 선택적 속성이며 제공되지 않으면 기본적으로 상태가 활성 상태가 됩니다.
state?: string
속성 값
string
userProperties
활동 사용자 속성입니다.
userProperties?: UserProperty[]