Use webhooks para ser notificado sobre eventos que acontecem em seu fórum.

Quando o evento ocorre, por exemplo, quando um novo usuário cria uma conta no seu fórum, o Website Toolbox cria um objeto de evento. Esse objeto contém todas as informações relevantes sobre o que acabou de acontecer, incluindo o tipo de evento e os dados associados a esse evento. Em seguida, enviamos o objeto Event como JSON para o URL do seu webhook por meio de uma solicitação HTTP POST.

Os webhooks funcionam muito bem quando combinados com a API do fórum. Por exemplo, o webhook pode notificar seu aplicativo quando um novo usuário se inscreve no seu fórum e, em seguida, você pode usar a API para fazer modificações na conta do fórum desse usuário.

O plano Growth ou Pro do fórum é necessário para usar esse recurso.

Definindo suas configurações de webhook

1. Faça login na sua conta do Website Toolbox.
2. Clique no link Integrar.
3. Clique no link Webhook.
4. Clique no botão Adicionar Webhook.
5. Insira o URL do seu webhook e selecione os eventos que você deseja receber.
6. Clique em Salvar.

Você pode criar vários webhooks para enviar eventos para URLs diferentes. Cada webhook pode ser configurado para receber diferentes tipos de eventos.

Respondendo a um webhook

Veja nosso código de exemplo para receber um evento de webhook.

Para confirmar o recebimento de um webhook, seu endpoint deve retornar um código de status HTTP 2xx. Qualquer outra informação retornada nos cabeçalhos ou no corpo da solicitação é ignorada. Todos os códigos de resposta fora desse intervalo, incluindo os códigos 3xx, indicarão que você não recebeu o webhook. Isso significa que um redirecionamento de URL ou uma resposta “Não modificada” será tratada como uma falha.

Se um webhook não for recebido com sucesso por qualquer motivo, continuaremos tentando enviar o webhook uma vez por hora por até 3 dias.

Um exemplo de evento

{
“api_version”: “1", 
 “data”: {
“object”: {“signature”: 
 “Obrigado, John.” , 
 “nome”: “John Doe”, “allowEmails”: false, 
 “lastPostTimeStamp”: 0, 
 “userGroups”: [7440, 2452, 52423], 
 “userTitle”: “Usuário avançado”, “reputação”: 423, 
 “nome de usuário”: “john”, “postCount”: 32, 
 “userID”: 181855, 
 “lastVisitTimeStamp””: 1322811119, 
 “InstantMessagingType”: “”, 
 “InstantMessagingId”: “”, “objeto”: “Usuário”, “invisível”: falso, 
 “email”: "johnDoe@gmail.com “, “AvatarUrl”: "https://test.com/images/avatar.png 
 “, 
 
 
 
 
 
“joinDateTimeStamp”: 1322811119, 
 “enableMessages”: true
}
}, “object”: “event”, 
 “id”: 1534, “type”: 
 “user.created”, 
 “mode”: “live”} 
 
 

Visualizando eventos e respostas do webhook

Você pode ver os eventos que foram enviados para o seu webhook e a resposta recebida do seu webhook seguindo as instruções abaixo:

1. Faça login na sua conta do Website Toolbox.
2. Clique no link Integrar.
3. Clique no link Webhook.
4. Clique no número de eventos do webhook que você deseja visualizar.