Help > Forum > Integración del sitio web > Uso de webhooks

Uso de webhooks

Utilice webhooks para recibir notificaciones sobre los eventos que ocurren en su foro.

Cuando se produce el evento, por ejemplo, cuando un nuevo usuario crea una cuenta en el foro, Website Toolbox crea un objeto Event. Este objeto contiene toda la información relevante sobre lo que acaba de suceder, incluido el tipo de evento y los datos asociados con ese evento. A continuación, enviamos el objeto Event como JSON a su URL de webhook a través de una solicitud HTTP POST.

Los webhooks funcionan muy bien cuando se combinan con el API del foro- Sí. Por ejemplo, el webhook puede notificar a su aplicación cuando un nuevo usuario se registra en su foro y luego puede usar la API para realizar modificaciones en la cuenta del foro de ese usuario.

Actualmente se admiten los siguientes eventos: user.created, user.approved, user.updated, user.deleted, user.email.verified, user.payment.received, user.paid_subscription.started, user.paid_subscription.ended, tempic.created, tempic.updated, topic.deleted, post.created, post.approved, post.updated, post.deleted conversation.created y message.created. Por favor, por favor háganoslo saber si necesita un cierto nuevo evento webhook.


Configuración de los webhook

  1. Inicie sesión en su cuenta de Website Toolbox.
  2. Haga clic en el botón Configuración enlace.
  3. En la Configuración , haga clic en el botón Notificación enlace.
  4. Introduzca la URL de su webhook en el cuadro de texto junto a la Webhook .

Responder a un webhook

Para acusar recibo de un webhook, su endpoint debe devolver un código de estado HTTP 2xx. Cualquier otra información que se devuelva en los encabezados de solicitud o en el cuerpo de solicitud se ignora. Todos los códigos de respuesta fuera de este rango, incluidos los códigos 3xx, indicarán que no recibió el webhook. Esto significa que una redirección de URL o una respuesta “No modificada” se tratará como un error.

Si un webhook no se recibe correctamente por cualquier motivo, seguiremos intentando enviar el webhook una vez por hora durante un máximo de 3 días.


Un evento de ejemplo

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

Visualización de eventos y respuestas de webhook

Puede ver los eventos que se enviaron a su webhook y la respuesta que se recibió de su webhook siguiendo las instrucciones siguientes:

  1. Inicie sesión en su cuenta de Website Toolbox.
  2. Haga clic en el botón General enlace.
  3. En la General , haga clic en el botón Webhook (Si no hay ningún enlace Webhook , eso significa que no se ha proporcionado una URL de webhook en la configuración de webhook todavía.)


If you still need help, please contact us.