Usando webhooks

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 fórum - o Website Toolbox cria um objeto Event. 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 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 inscrever no 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.

Atualmente, os seguintes eventos são suportados: user.created, user.approved, user.updated, user.deleted, user.email.verified, user.payment.received, user.paid_subscription.started, user.paid_subscription.ended, topic.created, topic.updated, topic.deleted, post.created, post.approved, post.updated, post.deleted, conversation.created e message.created. Por favor, informe-nos se você precisar de um determinado novo evento webhook.

Definindo suas configurações de webhook

1. Faça login na sua conta do Website Toolbox.
2. Clique no botão Integrar link.
3. Clique no botão Webhook link.
4. Insira o URL do webhook na caixa de texto ao lado da Webhook opção.

Respondendo a um 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 da solicitação ou no corpo da solicitação é ignorada. Todos os códigos de resposta fora desse intervalo, incluindo 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": "Thanks, John.",
      "name": "John Doe",
      "allowEmails": false,
      "lastPostTimestamp": 0,
      "userGroups": [7440, 2452, 52423],
      "userTitle": "Power User",
      "reputation": 423,
      "username": "john",
      "postCount": 32,
      "userId": 181855,
      "lastVisitTimestamp": 1322811119,
      "instantMessagingType": "",
      "instantMessagingId": "",
      "object": "User",
      "invisible": false,
      "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 visualizar os eventos que foram enviados para 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 botão Conteúdo link.
3. No Conteúdo menu, clique no botão Logs Webhook link. (Se não houver Logs Webhook link, isso significa que um URL de webhook não foi fornecido no configurações de webhook ainda.)

If you still need help, please contact us.