Ganchos de teia #

Webhooks podem ser usados para gerar notificações externas de alterações de usuários e/ou clientes. Estas notificações, quando combinadas com o REST API são essenciais para automatizar o provisionamento de usuários e manter os sistemas externos de configuração/faturamento atualizados.

Os eventos de gancho da Web serão acionados para eventos C.R.U.D em usuários e clientes. O REST API pode então ser usado pelo aplicativo recetor para consultar as informações específicas sobre as alterações usando as Ids fornecidas na carga útil do webhook.

Parâmetros #

Parâmetro	Opções	Descrição
Tipo de entidade	Utilizador, Cliente	A entidade para a qual o gatilho pode disparar. Crie vários gatilhos para capturar as alterações do Usuário e do Cliente.
Evento	Criado / Atualizado / Excluído	Selecione um ou mais tipos de evento nos quais o gatilho será acionado. *Nota: O tipo de evento que causa um gatilho está incluído na carga útil.
URL	https://	Fornecer um HTTPS URL que o gatilho chamará quando acionado.
Método de solicitação	GET, POST, PUT	Escolha o método de solicitação necessário para o webhook.
Formato do pedido	JSON, Dados do formulário	Escolha o formato de solicitação necessário para o webhook if POST ou PUT são selecionados como o método Request.
Dados adicionais sobre a carga útil	Par chave/valor	Se necessário, informações estáticas adicionais podem ser adicionadas à carga útil do webhook. Insira quaisquer dados adicionais como pares chave/valor, conforme necessário.
Tentativas de repetição	0 - 10	Padrão 1. Insira o número de vezes que o webhook deve tentar novamente se em algum momento houver um malsucedido

warning
A configuração do gatilho Webhook é armazenada em cache para melhorar o desempenho. Quaisquer novos gatilhos ou alterações em gatilhos existentes podem levar até 10 minutos antes de entrarem em vigor.

info
O tempo limite para uma solicitação de webhook é de 10 segundos. O tempo entre as tentativas de repetição é igual ao Número da tentativa x 2 segundos

Dados de carga útil #

A tabela abaixo mostra os dados fornecidos na carga útil do gatilho.

Parâmetro	Descrição
ID do gatilho	O id exclusivo para o gatilho para o qual a solicitação de gancho da Web está sendo disparado.
ID	A id da entidade que está mudando (ID do usuário ou ID do locatário).
inquilinoId	O ID do locatário do cliente ao qual o evento está associado.
eventType	O tipo de evento que gera o gancho da web. Ou criar, atualização ou suprimir
customData	Se configurado contra o gatilho, qualquer informação adicional do par chave/valor da carga útil será passada aqui.

tip
O triggerId pode ser encontrado editando um gatilho configurado no Portal do Revendedor e copiando o GUID a partir do final do URL. por exemplo, https://reseller.myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000

Exemplo JSON carga útil: #

Exemplo JSON formato de carga útil para PUT/POST Pedidos:

{
    "triggerId": "00000000-0000-0000-0000-000000000000",
    "id": "1468547c-a945-41d4-95e3-ffffffffffff",
    "tenantId": "a0ea7445-df78-4487-ffffffffffff",
    "configurationType": "user",
    "eventType": "update",
    "customData": {
        "myitemkey1": "myitemval1",
        "myitemkey2": "myitemval2"
    }
}

Exemplo de carga útil FORM Data #

Exemplo de carga útil de dados de formulário para PUT/POST Pedidos:

[triggerId, 00000000-0000-0000-0000-000000000000], [tenantId, a0ea7445-df78-4487-ffffffffffff], [id, 1468547c-a945-41d4-95e3-ffffffffffff], [configurationType, user], [eventType, update],[myitemkey1, myitemval1], [myitemkey2, myitemval2]

Exemplo GET solicitar #

Se o método Request de GET está configurado para o Webhook, os dados de carga útil são passados como parâmetros de cadeia de caracteres de consulta na solicitação.

http://example.url.com?triggerId=00000000-0000-0000-0000-000000000000&tenantId=a0ea7445-df78-4487-ffffffffffff&id=1468547c-a945-41d4-95e3-ffffffffffff&configurationType=user&eventType=update&hook=get&myitemkey1=myitemval1&myitemkey2=myitemval2