Uso de Webhooks

Utiliza webhooks para recibir notificaciones sobre los eventos que ocurren en tu 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 a ese evento. A continuación, enviamos el objeto Event como JSON a la URL de su webhook mediante una solicitud HTTP POST.

Los webhooks funcionan muy bien cuando se combinan con la API del foro. Por ejemplo, el webhook puede notificar a tu aplicación cuando un nuevo usuario se registra en tu foro y, a continuación, puedes usar la API para modificar la cuenta del foro de ese usuario.

El plan Growth o Pro del foro es necesario para utilizar esta función.

Actualmente se admiten los siguientes eventos: user.created, user.approved, user.updated, user.deleted, user.email.verified, user.payment.recibed, user.paid_subscription.started, user.paid_subscription.ended, topic.created, topic.updated, topic.updated, topic.created, post.created, post.created, post.approved, post.updated, post.borrado, conversation.created y message.created. Por favor, avísenos si necesita un nuevo evento webhook.

Configuración de los ajustes de webhook

1. Inicie sesión en su cuenta de Website Toolbox.
2. Haga clic en el Integrar enlace.
3. Haga clic en el Webhook enlace.
4. Introduzca la URL de su webhook en el cuadro de texto situado junto a la Webhook opción.

Responder a un webhook

Para acusar recibo de un webhook, el punto final debe devolver un código de estado HTTP 2xx. Se ignora cualquier otra información devuelta en los encabezados de la solicitud o en el cuerpo de la solicitud. Todos los códigos de respuesta fuera de este rango, incluidos los códigos 3xx, indicarán que no has recibido el webhook. Esto significa que una redirección de URL o una respuesta «No modificada» se tratarán como un error.

Si no se recibe correctamente un webhook 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

Puedes ver los eventos que se enviaron a tu webhook y la respuesta recibida de tu webhook siguiendo las instrucciones que se indican a continuación:

1. Inicie sesión en su cuenta de Website Toolbox.
2. Haga clic en el Contenido enlace.
3. En el Contenido , haga clic en el Registros de webhook enlace. (Si no hay Registros de webhook enlace, lo que significa que no se ha proporcionado una URL webhook en el configuración de webhook todavía.)

If you still need help, please contact us.