Skip to content
TB
TeamBenchResources
Advanced

Custom Webhook Setup

Quick Answer

Webhooks allow TeamBench to send real-time notifications to your application when events occur, such as when a review completes. Configure a webhook URL in your settings, and TeamBench will POST event data to your endpoint whenever the specified events happen.

Webhooks provide a push-based integration model where TeamBench sends data to your application in real time when specific events occur. Instead of polling the API to check for new review results, your application receives a notification the moment a review completes.

The most common webhook use case is receiving notifications when reviews complete. This enables workflows like: a writer submits content for review, the review processes asynchronously, and when it finishes, your application receives the scores and can automatically route the content to the next stage -- whether that is publishing, revision, or editorial review.

To set up a webhook, you need an endpoint on your server that can receive HTTP POST requests. This endpoint should accept JSON payloads, process the event data, and return a 200-series response to acknowledge receipt. The URL should be HTTPS for security, as webhook payloads may contain content and review data.

Configure your webhook in TeamBench by providing the endpoint URL and selecting which events should trigger notifications. Review completion is the primary event type. When a selected event occurs, TeamBench sends a POST request to your URL with a JSON payload containing the event type, the review data (scores, feedback, content reference), and metadata such as timestamps and reviewer information.

Your webhook endpoint should process payloads efficiently and return a response quickly. If your processing takes significant time -- for example, running additional analysis on the scores or updating a database -- acknowledge the webhook immediately and process the data asynchronously. This prevents timeout issues and ensures reliable delivery.

Implement webhook verification to ensure incoming requests genuinely originate from TeamBench. Check the request headers for authentication signatures or tokens that verify the request's authenticity. This prevents malicious actors from sending fake events to your endpoint.

Handle delivery failures gracefully. If your endpoint is temporarily unavailable, the webhook delivery may fail. Implement idempotency in your event processing so that if the same event is delivered multiple times (due to retries), your application handles it correctly without creating duplicate actions.

Common webhook integrations include updating a content management system with review scores, sending Slack notifications when content passes or fails quality thresholds, triggering automated publishing pipelines for content that meets standards, and logging review results to external analytics platforms. The flexibility of webhooks lets you connect TeamBench to virtually any system that can receive HTTP requests.

For complex integrations that involve multiple event types, conditional logic, or multi-step workflows, consider using a workflow automation platform (such as Zapier or Make) as an intermediary between TeamBench webhooks and your destination systems. This adds a visual workflow builder without requiring custom server-side code.

Related Questions

What events can trigger webhooks?

The primary webhook event is review completion, which fires when a content review finishes processing and scores are available. Additional event types may be available depending on your plan and configuration. Check the webhook settings for the current list of supported events.

What does the webhook payload look like?

The webhook payload is a JSON object containing the event type, review data (overall score, per-criterion scores and feedback), content metadata, reviewer information, and timestamps. The exact structure is documented in the API reference.

What happens if my webhook endpoint is down?

If a webhook delivery fails, the system may retry the delivery with exponential backoff. If all retries fail, the event is logged but not delivered. You can check for missed events using the API to retrieve recent reviews.

Can I test webhooks locally during development?

Yes. Use a tunneling tool like ngrok to expose a local endpoint to the internet, then configure the ngrok URL as your webhook endpoint in TeamBench. This allows you to receive and debug webhook payloads locally during development.

Still have questions?

Try TeamBench free and see how AI-powered content review works for your team.

Start Free Trial