Após um webhook ser acionado, uma carga útil é entregue ao URL de carga útil especificado. Cada evento para um tipo de webhook específico segue um esquema JSON semelhante, contendo informações relevantes para o evento com suporte. As seções abaixo definem as propriedades incluídas nas cargas úteis e fornecem exemplos de cargas úteis para webhooks de organização e serviço.
Cargas úteis do webhook da organização
A tabela a seguir lista as propriedades incluídas nas cargas para os webhooks da sua organização, retornando informações sobre alterações e atualizações para usuários, grupos, itens e papéis em sua organização.
| Propriedade | Descrição |
|---|---|
| webhookName | O nome do webhook que entregou a carga útil. |
| webhookId | O ID do webhook que entregou a carga útil. |
| portalURL | A URL do portal para o qual o webhook está registrado. |
| when | A hora na qual a carga útil foi entregue. |
| username | O usuário que ativou o evento. |
| userId | O ID do usuário que ativou o evento. |
| when | A hora que ocorreu o evento. |
| operation | O tipo de operação executada pelo usuário. A lista abaixo descreve a propriedade do tipo de operação retornada na carga útil e suas operações associadas da API do Portal Directory:
|
| source | O tipo de item no qual a operação foi executada. Isto pode ser items, group ou user. |
| id | O ID do item de origem no qual a operação foi executada. |
| properties | As propriedades adicionais associadas a gatilhos de eventos específicos. A lista a seguir descreve as propriedades adicionais incluídas na carga útil. Para obter mais informações sobre quais gatilhos de eventos incluem propriedades adicionais, consulte Eventos de ativação ou clique nas propriedades abaixo para saber mais sobre uma ativação específica e suas propriedades. |
Exemplo de carga útil
O exemplo a seguir ilustra uma carga útil de amostra para um webhook da organização que é acionado quando um grupo específico é atualizado:
{
"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": {}
}
]
}Cargas úteis do webhook do serviço de geoprocessamento
A tabela a seguir lista as propriedades incluídas em cargas úteis para webhooks de serviço de geoprocessamento, retornando informações sobre alterações feitas em seus serviços de geoprocessamento.
| Propriedade | Descrição |
|---|---|
| serviceType | O tipo de serviço para o qual o webhook foi configurado. Para webhooks de serviço da feição, esta propriedade retornará apenas GPServer. |
| jobId | O ID do trabalho de serviço de geoprocessamento. |
| statusURL | A URL de status do trabalho do serviço de geoprocessamento que pode ser pesquisada para retornar as informações de status do trabalho. |
| name | O nome de webhook |
| taskName | O nome da ferramenta de geoprocessamento. |
| folderName | A pasta onde está localizado o serviço de geoprocessamento. |
| serviceName | O nome do serviço de geoprocessamento. |
| eventType | A propriedade que representa como o trabalho do serviço de geoprocessamento foi concluído. Os webhooks do serviço de geoprocessamento não assinam eventos de ativação específicos. Em vez disso, esses webhooks entregam suas cargas úteis assim que um trabalho de serviço de geoprocessamento é concluído. Essas cargas úteis listam se o trabalho foi concluído com sucesso (esriJobSucceeded), sem sucesso (esriJobFailed), ou se o trabalho foi cancelado (esriJobCancelled). Valores: esriJobSucceeded | esriJobFailed | esriJobCancelled |
| when | O carimbo de data/hora (formatado em milissegundos desde a época) de quando o trabalho foi concluído. |
Exemplo de carga útil
O exemplo a seguir ilustra uma carga útil de amostra para um webhook de serviço de geoprocessamento que é acionado quando uma tarefa de serviço de geoprocessamento é concluída.
{
"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
}
]
}Cargas úteis do webhook do serviço de feição
A tabela a seguir lista as propriedades incluídas em cargas úteis para webhooks de serviço da feição, retornando informações sobre as alterações feitas em seus serviços da feição.
| Propriedade | Descrição |
|---|---|
| serviceType | O tipo de serviço para o qual o webhook foi configurado. Para webhooks de serviço da feição, esta propriedade retornará apenas FeatureServer. |
| changesUrl | A URL para o parâmetro Extrair Alterações do serviço. Embora apenas o evento de ativação e a hora da ocorrência estejam incluídos na carga, você pode acessar esse URL para saber mais sobre as alterações específicas que ocorreram durante o evento. |
| id | O ID do webhook que entregou a carga útil. |
| folderName | A pasta onde o serviço da feição está localizado. |
| serviceName | O nome do serviço da feição. |
| eventType | O tipo de evento executado no serviço da feição. Para saber mais sobre os valores de tipo de alteração que você pode assinar ao configurar seu webhook, consulte o tópico Evento de Ativação. Valores: * | FeaturesCreated | FeaturesUpdated | FeaturesDeleted | FeaturesEdited | AttachmentsCreated | AttachmentsUpdated | AttachmentsDeleted | LayerSchemaChanged | LayerDefinitionChanged | FeatureServiceDefinitionChanged |
| when | O carimbo de data/hora (formatado em milissegundos desde a época) de quando o evento ocorreu. |
Exemplo de carga útil
O exemplo a seguir ilustra uma carga útil de amostra para um webhook de serviço da feição que é acionado quando um serviço da feição é atualizado (FeaturesUpdated), excluído (FeaturesDeleted), e editado (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
}
]
}