Webhooks

Webhooks #

Os webhooks podem ser usados para gerar notificações externas de alterações de usuários e/ou clientes. Essas 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 web hook serão acionados para eventos C.R.U.D em usuários e clientes. O REST API pode então ser usado pelo aplicativo receptor 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 Usuário, Cliente A entidade para a qual o gatilho pode ser disparado. Crie vários gatilhos para capturar as alterações do usuário e do cliente.
Acontecimento Criado / Atualizado / Excluído Selecione um ou mais tipos de evento nos quais o gatilho será acionado. *Observação: o tipo de evento que causa um gatilho está incluído na carga.
URL https:// Forneça um HTTPS URL que o gatilho chamará quando disparado.
Método de solicitação GET, POST, PUT Escolha o método de solicitação necessário para o webhook.
Formato da solicitação JSON, dados do formulário Escolha o formato de solicitação necessário para o webhook se POST ou PUT são selecionados como o método Request.
Dados adicionais de 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 a qualquer momento houver um erro de
Hand Left warning
A configuração do gatilho do webhook é armazenada em cache para melhorar o desempenho. Quaisquer novos gatilhos ou alterações nos gatilhos existentes podem levar até 10 minutos para entrar em vigor.
Information Circle 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 de gatilho O ID exclusivo do gatilho para o qual a solicitação de web hook está sendo disparada.
id A ID da entidade que está sendo alterada (ID do usuário ou ID do locatário).
ID do inquilino A ID do locatário do cliente à qual o evento está associado.
tipo de evento O tipo de evento que gera o web hook. Ou criar, atualizar ou excluir
Dados personalizados Se configurado em relação ao gatilho, qualquer informação adicional do par chave/valor de carga útil será passada aqui.
Color Wand tip
O triggerId pode ser encontrado editando um gatilho configurado no Portal do Revendedor e copiando o GUID 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 Solicitações:

{
    "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 payload de dados FORM #

Exemplo de payload de dados de formulário para PUT/POST Solicitações:

[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 pedir #

Se o método Request de GET estiver configurado para o Webhook, os dados de carga útil serão passados como parâmetros de string 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