Webhooks overview and setup

Receive conversation changes from ThriveDesk instead of polling the REST API.

Webhooks send an HTTP request to your server when a selected ThriveDesk event occurs. Use them to start workflows quickly, then use the REST API when you need the latest complete resource state.

Prerequisites

  • A public HTTPS endpoint that can receive POST requests.
  • A random signing secret stored in a secrets manager.
  • An idempotent queue or event handler.

Configure a webhook

In the ThriveDesk App Store, install Webhook, name the integration, enter its callback URL and secret, choose events, select the inboxes it applies to, and save it.

Your endpoint should verify X-TD-SIGNATURE, enqueue the event, and return a 2xx quickly.

app.post('/webhooks/thrivedesk', rawJsonMiddleware, async (request, response) => {
  verifyThriveDeskSignature(request);
  await queue.publish(request.body);
  response.sendStatus(204);
});

Do not process before verification

Treat every request as attacker-controlled until its signature matches. Keep the secret on the server and rotate it if it is exposed.