Ao criar um webhook, você pode optar por assinar ativadores de eventos específicos vinculados a operações de API que solicitarão seu webhook e fornecerão as informações do evento por meio da carga útil. As seções abaixo listam os ativadores de eventos disponíveis e seus URIs associados ou valores de tipo de alteração para webhooks de serviço da feição e da organização.
Anotação:
Ao contrário dos webhooks de serviço da feição e da organização, os webhooks do serviço de geoprocessamento não têm ativadores de eventos definidos pelo usuário. Os webhooks do serviço de geoprocessamento entregam cargas úteis assim que um trabalho de geoprocessamento é concluído. Para mais informações sobre as cargas úteis entregues para serviços de geoprocessamento, consulte o tópico Cargas Úteis.
Eventos de item da organização
A tabela a seguir lista os ativadores de eventos para os itens da sua organização, que incluem mapas da web, aplicativos da web, camadas, pacotes e PDFs:
| Ativador de evento | URI |
|---|---|
Todos os eventos de ativação para todos os itens | /items |
Um item está adicionado ao portal | /items/add |
Nenhum item está excluído | /items/delete |
Nenhum item está atualizado | /items/update |
Nenhum item está movido ou sua propriedade está alterada | /items/move |
Nenhum item está publicado | /items/publish |
Nenhum item está compartilhado | /items/share |
Nenhum item está descompartilhado | /items/unshare |
A propriedade de nenhum item está reatribuída | /items/reassign |
Um comentário é adicionado a qualquer item | /items/addComment |
Um comentário é excluído de qualquer item | /items/deleteComment |
Um comentário é atualizado em qualquer item | /items/updateComment |
Todos os eventos de ativação para um item específico | /items/<itemID> |
Um item específico está excluído | /items/<itemID>/delete |
As propriedades de um item específico estão atualizadas Anotação:As propriedades do item que podem ser atualizadas variam entre tipos de itens e há ações exclusivas que ativam a operação Update. Por exemplo, se o item for um mapa da web, a atualização da tag, a configuração de um pop-up ou a alteração do mapa base serão todos eventos de atualização que ativarão o webhook. | /items/<itemID>/update |
A propriedade de um item específico está alterada ou o item está movido | /items/<itemID>/move |
Um item específico está publicado | /items/<itemID>/publish |
Um item específico está compartilhado | /items/<itemID>/share |
Um item específico está descompartilhado | /items/<itemID>/unshare |
A propriedade de um item específico está reatribuída | /items/<itemID>/reassign |
Um comentário é adicionado a um item específico | /items/<itemId>/addComment |
Um comentário é excluído de um item específico | /items/<itemId>/deleteComment |
Um comentário é atualizado sobre um item específico | /items/<itemId>/updateComment |
Propriedades do ativador de evento do item
Alguns dos ativadores de eventos para itens da organização retornam propriedades adicionais em suas cargas úteis. As seções abaixo descrevem as propriedades de carga útil adicionais para esses ativadores.
Um item específico está compartilhado
Os webhooks que assinam o ativador de eventos do /items/<itemID>/share têm a propriedade sharedToGroups incluída em sua carga útil. A propriedade sharedToGroups especifica como um item foi compartilhado. Se o item foi compartilhado com um grupo, o objeto JSON properties incluirá o ID de cada grupo com o qual o item foi compartilhado. Se o item foi compartilhado com a organização como um todo, o objeto incluirá Organization. Se o item foi compartilhado publicamente, o objeto incluiráEveryone. O exemplo abaixo demonstra o compartilhamento de um item para grupos específicos, como também, o compartilhamento de um item publicamente e para grupos específicos.
Exemplos
//groupIDs
"properties": {
"sharedToGroups": [
"ecd6646698b24180904e4888d5eaede3",
"2dff15c514ad4f04b291e304e24a524b"
]
}
//Everyone and groupIDs
"properties": {
"sharedToGroups": [
"Everyone",
"4adc30bb03054812a846fa592de105de",
"a4e6e37e2f7d4bb5b64d587c91d39a2c"
]
}A propriedade de nenhum item está reatribuída
Os webhooks que assinam o ativador de eventos do /items/reassign têm a propriedade reassignedTo incluída em sua carga útil. A propriedade reassignedTo especifica o novo usuário ao qual um item ou grupo é reatribuído, retornando o nome de usuário do novo proprietário no objeto JSON properties.
Exemplo
"properties": {
"reassignedTo": ["newOwner"]
}Um item específico está descompartilhado
Os webhooks que assinam o ativador de eventos do /items/<itemID>/unshare têm a propriedade unsharedFromGroups incluída em sua carga útil. A propriedade unsharedFromGroups especifica como um item foi descompartilhado. Se o item não tiver sido compartilhado de um grupo, o objeto JSON properties incluirá as IDs de cada grupo do qual o item foi descompartilhado. Se o item não foi compartilhado da organização como um todo, o objeto incluirá Organization. Se o item não foi compartilhado com o público, o objeto incluiráEveryone. As propriedades de exemplo abaixo demonstram como cancelar o compartilhamento de um item do público, como também, cancelar o compartilhamento de um item de um grupo específico.
Exemplos
//Everyone
"properties": {
"unsharedFromGroups": ["Everyone"]
}
//groupID
"properties": {
"unsharedFromGroups": [
"4adc30bb03054812a846fa592de105de"
]
}A propriedade de um item específico está reatribuída
Os webhooks que assinam o ativador de eventos do /items/<itemID>/reassign têm a propriedade reassignedTo incluída em sua carga útil. A propriedade reassignedTo especifica o novo usuário ao qual um item ou grupo é atribuído, retornando o nome de usuário do novo proprietário no objeto JSONproperties.
Exemplo
"properties": {
"reassignedTo": ["newOwner"]
}Eventos de grupo da organização
A tabela a seguir lista os ativadores de eventos para os grupos da sua organização:
| Ativador de evento | URI |
|---|---|
Todos os eventos de ativação para todos os grupos | /groups |
Um grupo esta adicionado | /groups/add |
Nenhum grupo está atualizado | /groups/update |
Nenhum grupo está excluído | /groups/delete |
Proteção de Exclusão está habilitada para qualquer grupo | /groups/protect |
Proteção de Exclusão está desabilitada para qualquer grupo | /groups/unprotect |
Um usuário é convidado para qualquer grupo | /groups/invite |
Um usuário é adicionado para qualquer grupo | /groups/addUsers |
Um usuário é removido de qualquer grupo | /groups/removeUsers |
Um papel de usuário é atualizado em qualquer grupo | /groups/updateUsers |
A propriedade de nenhum grupo é reatribuída | /groups/reassign |
Um item está compartilhado com qualquer grupo | /groups/itemShare |
Um item não está compartilhado em nenhum grupo | /groups/itemUnshare |
Um usuário envia uma solicitação para ingressar em qualquer grupo | /groups/requestJoin |
Todos os eventos de ativação para um grupo específico | /groups/<groupID> |
Um grupo específico está atualizado Anotação:Quaisquer alterações gerais realizadas nas configurações do grupo constituem uma atualização. Por exemplo, alterar o acesso de um grupo ativará um evento de atualização. | /groups/<groupID>/update |
Um grupo específico está excluído | /groups/<groupID>/delete |
Proteção de Exclusão está habilitada para um grupo específico | /groups/<groupID>/protect |
Proteção de Exclusão está desabilitada para um grupo específico | /groups/<groupID>/unprotect |
Um usuário é convidado para um grupo específico | /groups/<groupID>/invite |
Um usuário é adicionado para um grupo específico | /groups/<groupID>/addUsers |
Um usuário é removido de um grupo específico | /groups/<groupID>/removeUsers |
Um papel de usuário é atualizado em um grupo específico | /groups/<groupID>/updateUsers |
A propriedade para um grupo específico é reatribuída | /groups/<groupID>/reassign |
Um item está compartilhado com um grupo | /groups/<groupID>/itemShare |
Um item não está compartilhado de um grupo | /groups/<groupID>/itemUnshare |
Um usuário solicita ingressar em um grupo específico | /groups/<groupId>/requestJoin |
Propriedades do ativador de evento do grupo
Alguns dos ativaodres de eventos para grupos organizacionais retornam propriedades adicionais na carga útil. As seções abaixo descrevem as propriedades de carga útil adicionais para esses ativadores.
Um usuário é convidado para um grupo específico
Os webhooks que assinam o ativador de eventos do /groups/<groupID>/invite têm a propriedade invitedUserNames incluída em sua carga útil. A propriedade invitedUserNames especifica os nomes de usuário dos usuários convidados para um grupo, retornando uma lista de nomes de usuário no objeto JSON properties.
Exemplo
"properties": {
"invitedUserNames": [
"u1TestUser",
"u2TestUser"
]
}Um usuário é adicionado para um grupo específico
Os webhooks que assinam o ativador de eventos do /groups/<groupID>/addUsers têm a propriedade addedUserNames incluída em sua carga útil. A propriedade addedUserNames especifica os nomes de usuário dos usuários que foram adicionados a um grupo, retornando uma lista de nomes de usuário no objeto JSON properties.
Exemplo
"properties": {
"addedUserNames": [
"u1TestUser",
"u2TestUser"
]
}Um usuário é removido de um grupo específico
Os webhooks que descrevem /groups/<groupID>/removeUsers têm a propriedade removeUserNames incluída em sua carga útil. A propriedade removeUserNames especifica os nomes de usuário dos usuários removidos de um grupo, retornando uma lista de nomes de usuário no objeto JSON properties.
Exemplo
"properties": {
"removedUserNames": [
"u1TestUser",
"u2TestUser"
]
}Um papel de usuário é atualizado em um grupo específico
Os webhooks que descrevem /groups/<groupID>/updateUsers têm a propriedade updateUserNames incluída em sua carga útil. A propriedade updateUserNames especifica os nomes de usuário dos usuários cujos papéis do grupo foram atualizadas, retornando uma lista de nomes de usuário no objeto JSON properties.
Exemplo
"properties": {
"updatedUserNames": [
"u1TestUser",
"u2TestUser"
]
}Um item está compartilhado com um grupo
Os webhooks que descrevem /groups/<groupID>/itemShare têm a propriedade sharedItems incluída em sua carga útil. A propriedade sharedItems especifica o itemID e tipo de item do item compartilhado com um grupo, retornando essas informações no objeto JSON properties.
Exemplo
"properties": {
"sharedItems": [
{
"itemId": "6cd80cb32d4a4b4d858a020e57fba7b1",
"itemType": "Map Package"
}
]
}Um item não está compartilhado de um grupo
Os webhooks que descrevem /groups/<groupID>/itemUnshare têm a propriedade unsharedItems incluída em sua carga útil. A propriedade unsharedItems especifica o itemID e tipo de item do item descompartilhado de um grupo, retornando essas informações no objeto JSON properties.
Exemplo
"properties": {
"unsharedItems": [
{
"itemId": "7dd95fadaec84859ab8ed1059e675e0c",
"itemType": "Image"
}
]
}Eventos de usuário da organização
A tabela a seguir lista os ativadores de eventos para os usuários da sua organização:
| Ativador de evento | URI |
|---|---|
Todos os eventos de ativação para todos os usuários no portal | /users |
Um usuário é adicionado à organização | /users/add |
Nenhum usuário entrou no portal | /users/signin |
Nenhum usuário saiu do portal | /users/signout |
Nenhum usuário está excluído | /users/delete |
O perfil de nenhum usuário está atualizado Anotação:Um evento de atualização é ativado sempre que uma alteração é realizada no perfil do usuário. No entanto, as alterações realizadas no papel de um usuário, tipo de usuário ou licença não são consideradas uma atualização para o perfil do usuário. | /users/update |
A conta de nenhum usuário está desabilitada | /users/disable |
A conta de nenhum usuário está habilitada | /users/enable |
Nenhum usuário é atribuído um novo papel | /users/updateUserRole |
Nenhum usuário é atribuído um novo tipo de usuário | /users/updateUserLicenseType |
Uma lista de contas de usuário está habilitada | /users/bulkEnable |
Uma lista de contas de usuário está desabilitada | /users/bulkDisable |
Todos os eventos de ativação associados a um usuário específico | /users/<username> |
Um usuário especificado entrou no portal | /users/<username>/signIn |
Um usuário especificado saiu do portal | /users/<username>/signOut |
Um usuário específico está excluído | /users/<username>/delete |
Um perfil de usuário específico está atualizado Anotação:Um evento de atualização é ativado sempre que uma alteração é realizada no perfil do usuário. No entanto, as alterações realizadas no papel de um usuário, tipo de usuário ou licença não são consideradas uma atualização para o perfil do usuário. | /users/<username>/update |
Uma conta de usuário específico está desabilitada | /users/<username>/disable |
Uma conta de usuário específico está habilitada | /users/<username>/enable |
Um usuário específico está atribuído a um novo papel | /users/<username>/updateUserRole |
Um usuário específico está atribuído a um novo tipo de usuário | /users/<username>/updateUserLicenseType |
Propriedades do ativador de eventos do usuário
Alguns dos ativadores de eventos para usuários da organização retornam propriedades adicionais na carga útil. As seções abaixo descrevem as propriedades de carga útil adicionais para esses ativadores.
Um usuário específico está atribuído a um novo papel
Os webhooks que descrevem /users/<username>/updateUserRole têm a propriedade userRoleUpdatedTo incluída em sua carga útil. A propriedade userRoleUpdatedTo especifica um novo papel atribuído ao usuário, retornando um novo papel no objeto JSON properties.
"properties": {
"userRoleUpdatedTo": ["New role"]
}Um usuário específico está atribuído a um novo tipo de usuário
Os webhooks que descrevem /users/<username>/updateUserLicenseType têm a propriedade userLicenseTypeUpdatedTo incluída em sua carga útil. A propriedade userLicenseTypeUpdatedTo especifica o novo tipo de usuário atribuído a um usuário, retornando o novo tipo de usuário no objeto JSON properties.
"properties": {
"userLicenseTypeUpdatedTo": ["Editor"]
}Eventos de papel da organização
A tabela a seguir lista os ativadores de eventos para papéis de usuários da sua organização:
| Ativador de evento | URI |
|---|---|
Todos os eventos de ativação para todos os papéis no portal | /roles |
Um novo papel está criado | /roles/add |
Um papel existente está atualizado Anotação:Um evento de atualização é ativado sempre que uma alteração é realizada em papéis da organização. | /roles/update |
Um papel existente está excluído | /roles/delete |
Propriedades do ativador de evento do papel
Alguns dos ativadores de eventos para papéis da organização retornam propriedades adicionais na carga útil. A seção abaixo descreve as propriedades de carga útil adicionais para esses ativadores.
Um novo papel está criado
Os webhooks que assinam o ativador de eventos do /roles/add têm a propriedade name incluída em sua carga útil. A propriedade name especifica o nome do papel que foi criado, retornando o nome do papel no objeto JSON properties.
Exemplo
"properties": {
"name": ["New role"]
}Eventos do serviço da feição
A tabela a seguir lista os ativadores de eventos para webhooks de serviço da feição:
| Ativador de evento | Valor |
|---|---|
Nenhum evento é ativado | * |
Uma nova feição está criada | FeaturesCreated |
Uma feição está atualizada | FeaturesUpdated |
Uma feição está excluída | FeaturesDeleted |
Uma feição está editada (por exemplo, inserção, atualização ou exclusão) | FeaturesEdited |
Um novo anexo está adicionado a uma feição | AttachmentsCreated |
Um anexo de feição está atualizado | AttachmentsUpdated |
Um anexo de feição está excluído | AttachmentsDeleted |
O esquema de uma camada de feição está alterado | LayerSchemaChanged |
Uma definição da camada de feição está alterada | LayerDefinitionChanged |
Uma definição de serviço da feição está alterada | FeatureServiceDefinitionChanged |
A pós-operação é executada no serviço da feição. Anotação:Para planejar um webhook usando esse ativador de evento, o serviço da feição deve ter o recurso Gerenciamento de Versão habilitado. Para obter mais informações, consulte a documentação Criar webhooks. | FeaturesPosted |