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

Uso de Webhooks

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

Cuando se produce el evento, por ejemplo, cuando un nuevo usuario crea una cuenta en su 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 webhook a través de una solicitud HTTP POST.

Los webhooks funcionan muy bien cuando se combinan con el API de foro- Sí. Por ejemplo, el webhook puede notificar a su aplicación cuando un nuevo usuario se registra en su foro y, a continuación, puede utilizar 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, topic.created, topic.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 evento webhook nuevo.


Configuración de la configuración de 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 su URL de webhook en el cuadro de texto situado junto al cuadro de diálogo 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 devuelta en los encabezados de solicitud o en el cuerpo de la 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, continuaremos 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 Contenido enlace.
  3. En la Contenido , haga clic en el botón Webhook enlace. (Si no hay Webhook , lo que significa que no se ha proporcionado una URL de webhook en el configuración de webhook todavía.)


If you still need help, please contact us.