Webhooks

Receive signed HTTP callbacks when searches complete, scrapes finish, or your credit balance runs low.

Overview

Webhooks push events to an HTTPS endpoint you control as soon as they happen, so you don't have to poll usage or credits.

Available events:

  • search.completed — a search, batch, AI, or social-search request finished successfully
  • scrape.completed — a scrape finished successfully
  • credits.low — your balance dropped to 100 credits or below
  • credits.exhausted — your balance reached 0

Each delivery is a signed JSON POST. Retries use exponential backoff; an endpoint that keeps failing is marked inactive.

Webhooks are available on Pro and Enterprise plans from the Webhooks dashboard page.

Payload

Every delivery carries the event name, a timestamp, and the event payload:

json
json

Verifying Signatures

Each request includes an X-Jiro-Signature header: sha256=<hmac> computed with your endpoint's signing secret over the raw request body. Recompute the HMAC on your side and compare in constant time before trusting a payload.

javascript

Managing Endpoints

Create, test, and rotate endpoints from Dashboard → Webhooks. Select the events you want, paste your HTTPS URL, and use the Send test event button to fire a signed sample delivery before going live.

Delivery Log & Replay

Every delivery is persisted (last 100 per endpoint) with status code, latency, error, and attempt count. Expand Log on any webhook row in the dashboard to inspect deliveries and Replay any of them — replay re-signs the original payload and records a new attempt, so debugging a failing endpoint never requires re-triggering the source event.

bash

Need help?

Check our error codes or reach out to the team.