Skip to main content

Overview

Webhooks let you receive HTTP callbacks when specific events occur in your workspace like a lookup completing or an API key being created. Instead of polling the API, Encrata pushes event data directly to your server.

How it works

  1. You register a webhook URL in Settings → Webhooks on the dashboard.
  2. When a subscribed event occurs, Encrata sends a POST request to your URL with a JSON payload.
  3. Each delivery is signed with HMAC-SHA256 so you can verify it came from Encrata.

Supported events

Payload format

Every webhook delivery sends a JSON payload in the following shape:

Verifying signatures

Each webhook request includes an X-Encrata-Signature header containing the HMAC-SHA256 hex digest of the raw request body, signed with your webhook secret. To verify:
Always verify signatures before processing webhook payloads. Never trust unverified requests.

Requirements

  • Webhook URLs must use HTTPS.
  • Your endpoint should return a 2xx status code within 5 seconds.
  • Failed deliveries are retried with exponential backoff.

Managing webhooks

You can manage webhooks from the dashboard (Settings → Webhooks) or via the API:
Your webhook secret is shown only once when you create a webhook. Store it securely you’ll need it to verify signatures.