Help > Forum > Integração de sites > Usando Webhooks

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 em seu fórum - Website Toolbox cria um objeto Event. Este 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 seu URL webhook através de uma solicitação HTTP POST.

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

Os seguintes eventos são suportados atualmente: 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, por favor deixe-nos saber se você precisar de um determinado novo evento webhook.


Configurando as configurações do webhook

  1. Faça login na sua conta do Website Toolbox.
  2. Clique no botão Configurações link.
  3. Na Configurações , clique no botão Notificação link.
  4. Digite o URL do seu webhook na caixa de texto ao lado do 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. Quaisquer outras informações retornadas nos cabeçalhos da solicitação ou corpo da solicitação são ignoradas. Todos os códigos de resposta fora deste 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 modificado” 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 evento de exemplo

{
  "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"
}

Visualização de eventos e respostas do webhook

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

  1. Faça login na sua conta do Website Toolbox.
  2. Clique no botão Geral link.
  3. Na Geral , clique no botão Webhook link. (Se não houver nenhum Webhook , isso significa que um URL do webhook não foi fornecido no configurações do webhook ainda.)


If you still need help, please contact us.