Skip to main content

Webhooks

note

Webhooks are available on paid plans.

You can register a webhook so that when specific events happen in Hitprobe, a HTTP POST request is made to any external URL (the webhook endpoint) that you configure.

To manage a site's webhooks, go to Manage site > Webhooks > Manage. To create a new webhook, select Add webhook.

Supported event types

Blocked session

This webhook type will trigger every time a session is blocked. The payload will include all the fields returned for a GET /session/<id> API request, in addition to hook_type (set to "blocked_session") and other metadata fields.

Note, the webhook will take a few minutes to trigger after a session is blocked.

Retries and failures

Your endpoint must return a 2xx status code (i.e. 200 OK). If the endpoint can't be reached or returns a 4xx or 5xx status code, the webhook event will be retried up to 5 times with exponential backoff.

We'll notify you by email when a webhook event continues to fail after its automatic retries. If 10 or more consecutive webhook events fail over 3 or more days, the webhook will be disabled so you can fix the problem. We'll email you if this happens too.

You can view a history of each webhook's events and retry any failed events on the webhook events page (click the clock/history icon next to the webhook status in the list). You can only manually retry a webhook event once all automatic retries have completed.