웹후크가 트리거되면 페이로드가 지정된 페이로드 URL로 전달됩니다. 특정 웹후크 유형에 대한 각 이벤트는 지원되는 이벤트와 관련된 정보를 포함하는 유사한 JSON 스키마를 따릅니다. 아래 섹션에서는 페이로드에 포함된 등록정보를 정의하고 기관 및 서비스 웹후크에 대한 예시 페이로드를 제공합니다.
기관 웹후크 페이로드
다음 테이블에는 기관의 사용자, 그룹, 항목, 역할에 대한 변경 및 업데이트 정보를 반환하는 기관 웹후크의 페이로드에 포함된 등록정보가 나와 있습니다.
| 등록정보 | 설명 |
|---|---|
| webhookName | 페이로드를 전달한 웹후크의 이름입니다. |
| webhookId | 페이로드를 전달한 웹후크의 ID입니다. |
| portalURL | 웹후크가 등록된 포털 URL입니다. |
| when | 페이로드가 전달된 시간입니다. |
| username | 이벤트를 트리거한 사용자입니다. |
| userId | 이벤트를 트리거한 사용자의 ID입니다. |
| when | 이벤트가 발생한 시간입니다. |
| operation | 사용자가 수행한 작업 유형입니다. 페이로드 및 관련 포털 디렉터리 API 작업에서 반환된 작업 유형 등록정보가 아래 목록에 나와 있습니다. |
| source | 작업이 수행된 항목 유형입니다. items, group 또는 user일 수 있습니다. |
| id | 작업이 수행된 원본 항목의 ID입니다. |
| properties | 특정 이벤트 트리거와 관련된 추가 등록정보입니다. 다음 목록에는 페이로드에 포함된 추가 등록정보가 요약되어 있습니다. 추가 등록정보가 포함된 이벤트 트리거에 대한 자세한 내용은 이벤트 트리거를 참고하고 특정 트리거 및 해당 등록정보에 대한 자세한 내용은 아래 등록정보를 클릭하여 확인하세요. |
페이로드 예시
다음 예시에서는 특정 그룹이 업데이트되었을 때 트리거되는 기관 웹후크에 대한 샘플 페이로드를 보여줍니다.
{
"info": {
"webhookName": "Group monitoring",
"webhookId": "72fed926aeb74c9ca8a22aacddc6725a",
"portalURL": "https://orgURL/portal/",
"when": 1543192196521
},
"events": [
{
"username": "administrator",
"userId": "173dd04b69134bdf99c5000aad0b6298",
"when": 1543192196521,
"operation": "update",
"source": "group",
"id": "173dd04b69134bdf99c5000aad0b6298",
"properties": {}
}
]
}지오프로세싱 서비스 웹후크 페이로드
다음 테이블에는 지오프로세싱 서비스의 변경 사항에 대한 정보를 반환하는 지오프로세싱 서비스 웹후크의 페이로드에 포함된 등록정보가 나와 있습니다.
| 등록정보 | 설명 |
|---|---|
| serviceType | 웹후크가 구성된 서비스 유형입니다. 피처 서비스 웹후크의 경우 해당 속성은 GPServer만 반환합니다. |
| jobId | 지오프로세싱 서비스 작업의 ID입니다. |
| statusURL | 작업 상태 정보를 반환하기 위해 폴링할 수 있는 지오프로세싱 서비스 작업 상태 URL입니다. |
| name | 웹후크 이름입니다. |
| taskName | 지오프로세싱 도구 이름입니다. |
| folderName | 지오프로세싱 서비스가 있는 폴더입니다. |
| serviceName | 지오프로세싱 서비스 이름입니다. |
| eventType | 지오프로세싱 서비스 작업이 완료된 방법을 나타내는 등록정보입니다. 지오프로세싱 서비스 웹후크는 특정 이벤트 트리거를 구독하지 않습니다. 이러한 웹후크는 지오프로세싱 서비스 작업이 완료되면 페이로드를 전달합니다. 이러한 페이로드는 작업이 성공적으로 완료된 경우(esriJobSucceeded), 실패한 경우(esriJobFailed) 또는 작업이 취소된 경우(esriJobCancelled) 나열됩니다. 값: esriJobSucceeded | esriJobFailed | esriJobCancelled |
| when | 작업이 완료된 시간의 타임스탬프(에포크 이후 밀리초 형식)입니다. |
페이로드 예시
다음 예시에서는 지오프로세싱 서비스 작업이 완료될 때 트리거되는 지오프로세싱 서비스 웹후크에 대한 샘플 페이로드를 보여줍니다.
{
"serviceType": "GPServer",
"jobId": "jeccad3d9099d4e1591859fdb08f4d1eb",
"statusURL": https://machine.domain.com/webadaptor/rest/services/my_Service/GPServer/jobs/jeccad3d9099d4e1591859fdb08f4d1eb?f=pjson,
"name": "webhook1",
"taskName": "",
"folderName": "",
"serviceName": "my_Service",
"events": [
{
"eventType": "esriJobSucceeded",
"when": 1652458959318
}
]
}피처 서비스 웹후크 페이로드
다음 테이블에는 피처 서비스의 변경 사항에 대한 정보를 반환하는 피처 서비스 웹후크의 페이로드에 포함된 등록정보가 나와 있습니다.
| 등록정보 | 설명 |
|---|---|
| serviceType | 웹후크가 구성된 서비스 유형입니다. 피처 서비스 웹후크의 경우 해당 속성은 FeatureServer만 반환합니다. |
| changesUrl | 서비스에 대한 변경 사항 추출 엔드포인트의 URL입니다. 이벤트 트리거 및 발생 시간만 페이로드에 포함되지만 해당 URL에 접근하여 이벤트 중 발생한 특정 변경 사항에 대해 자세히 알아볼 수 있습니다. |
| id | 페이로드를 전달한 웹후크의 ID입니다. |
| folderName | 피처 서비스가 있는 폴더입니다. |
| serviceName | 피처 서비스 이름입니다. |
| eventType | 피처 서비스에서 수행되는 이벤트 유형입니다. 웹후크를 구성할 때 구독할 수 있는 변경 유형 값에 대한 자세한 내용은 이벤트 트리거 항목을 참고하세요. 값: * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged |
| when | 이벤트가 발생한 시간의 타임스탬프(에포크 이후 밀리초 형식)입니다. |
페이로드 예시
다음 예시에서는 피처 서비스가 업데이트(FeaturesUpdated), 삭제(FeaturesDeleted), 편집(FeaturesEdited)될 때 트리거되는 피처 서비스 웹후크에 대한 샘플 페이로드를 보여줍니다.
{
"serviceType": "FeatureServer",
"changesUrl": "https://machine.domain.com/webadaptor/rest/services/Hosted/my_Service/FeatureServer/extractChanges?serverGens=12942,13026",
"id": "84e17696-c9d8-43cc-9cf7-5aeb658db12b",
"folderName": "Hosted",
"serviceName": "my_Service",
"events": [
{
"eventType": "FeaturesUpdated",
"when": 1652459863334
},
{
"eventType": "FeaturesDeleted",
"when": 1652459863334
},
{
"eventType": "FeaturesEdited",
"when": 1652459863334
}
]
}