Webhooks

Webhooks are POST requests Truepic Vision sends to your server when events occur. Configure a webhook to receive inspection data and trigger your workflows when the events you need occur.

Webhooks are configured at the Team level, with one webhook per team. Select the events your webhook receives rather than sending every event to your endpoint. If you do not select events, the webhook receives every event for its team, including events your endpoint may not use.

Reduce unnecessary deliveries: Select only the events your integration handles. For example, choose ACTION_STATUS_READY_FOR_REVIEW if you only need to know when an inspection is ready for review. This reduces work for your server and avoids sending unneeded requests.

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.

See Webhook Actions for event names you can select.

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

Administrator users can select events when creating or editing a webhook in Settings > Webhooks. See Webhook Setup for dashboard steps and API-based configuration with enabled_events.