Webhooks

Webhooks are a POST requests sent by Truepic Vision to your server when actions happen within Truepic Vision. By setting up a webhook, your systems can be automatically notified when important events occur so you can automate workflows and receive inspection data directly into your existing systems as soon as it is available.

Webhooks are configured at the Team level. Once configured, a webhook will be sent for each event that occurs for every inspection that is sent for that team. One important restriction, to note is that only one webhook may be configured for each team.

Common webhook uses

  • Automate workflows when an inspection is ready for review
  • Trigger alerts when attempts to send new inspection requests to an app user have failed.
  • Update your systems when an app user unsubscribes from inspection requests.
  • Drive business logic using inspection metadata—for example, routing inspections to the right team or flagging inspections that fail automated checks.

To see all of the different actions that you can be notified of through a webhook see Webhook Actions

Retries

In your system, when you receive our webhook request, it is important that you return a 200 successful response within 10 seconds of receiving our webhook. If we do not receive 200 successful response within 10 seconds then we will try to resend the webhook again after 5 more minutes. If that fails we will try again after 10 minutes. And if that fails we will try again after 20 minutes. If we don't get a successful response after the 4th attempt, we will no longer try to send that webhook any more.

Webhook configuration

Webhook setup is managed by Administrator users via the dashboard: Settings > Webhooks. For more details see: Webhook Setup