Utilizzo di webhook

Usa i webhook per ricevere notifiche sugli eventi che si verificano nel tuo forum.

Quando si verifica l'evento, ad esempio quando un nuovo utente crea un account sul forum, Website Toolbox crea un oggetto Event. Questo oggetto contiene tutte le informazioni pertinenti su ciò che è appena accaduto, incluso il tipo di evento e i dati associati a quell'evento. Quindi inviamo l'oggetto Event come JSON all'URL del tuo webhook tramite una richiesta HTTP POST.

I webhook funzionano benissimo se combinati con l'API del forum. Ad esempio, il webhook può avvisare l'applicazione quando un nuovo utente si iscrive al forum e quindi è possibile utilizzare l'API per apportare modifiche all'account del forum dell'utente.

Per utilizzare questa funzione è necessario il piano Crescita o Pro del forum.

Attualmente sono supportati i seguenti eventi: 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. Fateci sapere se avete bisogno di un nuovo evento webhook.

Configurazione delle impostazioni del webhook

1. Accedi al tuo account Website Toolbox.
2. Fai clic sul Integrazione link.
3. Fai clic sul Webhook link.
4. Inserisci l'URL del tuo webhook nella casella di testo accanto al Webhook opzione.

Risposta a un webhook

Per confermare la ricezione di un webhook, l'endpoint dovrebbe restituire un codice di stato HTTP 2xx. Qualsiasi altra informazione restituita nelle intestazioni della richiesta o nel corpo della richiesta viene ignorata. Tutti i codici di risposta al di fuori di questo intervallo, inclusi i codici 3xx, indicheranno che non hai ricevuto il webhook. Ciò significa che un reindirizzamento URL o una risposta «Non modificata» saranno trattati come un errore.

Se un webhook non viene ricevuto correttamente per qualsiasi motivo, continueremo a provare a inviare il webhook una volta all'ora per un massimo di 3 giorni.

Un evento di esempio

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

Visualizzazione di eventi e risposte webhook

Puoi visualizzare gli eventi inviati al tuo webhook e la risposta ricevuta dal tuo webhook seguendo le istruzioni riportate di seguito:

1. Accedi al tuo account Website Toolbox.
2. Fai clic sul Contenuti link.
3. Nel Contenuti menu, fai clic sul Registri Webhook link. (Se non c'è Registri Webhook link, ciò significa che non è stato fornito un URL webhook nel impostazioni webhook ancora.)

If you still need help, please contact us.