Skip to main content

Documentation Index

Fetch the complete documentation index at: https://brezelscraper.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the integrations surface when you want to automate BrezelScraper outside the dashboard.

​
What integrations are for

  • Use API keys for authenticated server-to-server API calls.
  • Use webhook configurations when you want BrezelScraper to call back to your automation endpoint.
  • Use the dashboard for creating and revoking both from one place under Integrations.
For most users, the most reliable pattern is:
  1. Create an API key.
  2. Create a job with POST /api/v1/jobs.
  3. Check status with GET /api/v1/jobs/{id} until the job reaches completed, failed, or cancelled.
  4. Fetch results with GET /api/v1/jobs/{id}/results or download CSV with GET /api/v1/jobs/{id}/download.
This works well in n8n, cron jobs, backend workers, and other automation tools because the API response shapes are documented on this site.

​
Using n8n

BrezelScraper works with n8n in two main ways:
  • API-first: use n8n’s HTTP Request node to create jobs, poll status, and fetch results
  • Webhook-triggered fetch: point a BrezelScraper webhook configuration at an n8n Webhook node, then use the incoming call to trigger follow-up API requests
Both approaches work well. Start with API-first if you want simplicity, or add webhooks if you want BrezelScraper to notify you as soon as a job finishes.

​
API keys

Use API keys when n8n or another automation tool needs to call BrezelScraper directly.
  • BrezelScraper accepts Authorization: Bearer bscraper_...
  • BrezelScraper also accepts X-API-Key: bscraper_...
  • The full key is shown exactly once when you create it
Continue with API keys for the management endpoints and Authentication for header examples.

​
Webhook configurations

Webhook configurations let you register an HTTPS callback URL in your account.
  • The URL must be HTTPS
  • Unsafe or local targets are rejected
  • You can keep up to 10 active webhook configurations
If you use n8n, register the workflow’s Production URL, not the test URL. When a job finishes, BrezelScraper sends a signed POST to your webhook URL with the job ID, status, and result count. Your endpoint verifies the signature, then fetches results through the API. Continue with Webhooks for setup instructions, event types, signature verification, and endpoint management.

​
Next step

If you want a practical n8n setup, continue with Use BrezelScraper with n8n.