Guides
Connect an HTTP API
Configure an HTTP System for subject delete calls.
Connect an HTTP API
Source: app_docs/guide/connectors.md.
Goal
An enabled HTTP API System that Rights jobs can call when a deletion runs.
When to use it
Your product exposes an API that can delete or erase subject data by identifier (email or external id).
Configuration (documented fields)
| Area | Detail |
|---|---|
| Purpose | Call customer REST endpoint for subject delete |
| Config | baseUrl, pathTemplate ({{email}}, {{externalId}}), method |
| Auth | API key in secrets; header name/prefix configurable |
| Permissions | Key must be allowed to delete only intended resources |
| Execution | Outbound HTTP; SSRF checks on base URL |
| Limitations | Customer API must be idempotent-friendly under retries |
HTTP systems do not use SQL Data Maps.
Idempotency under retries
Rights jobs requeue retryable errors with backoff, so your endpoint can receive the same delete more than once. Handle it idempotently: deduplicate on an event or request id, and make a repeated delete return success rather than an error. The design guidance in Webhook retries and idempotency applies the same way to HTTP Systems.
Steps
- Rights → Systems → add HTTP API.
- Set
baseUrl, path template, method, and auth material as the product form requires. - Save secrets (encrypted at rest).
- Health / test as offered (
POST …/connectors/:id/test). - Enable the connector.
Troubleshoot
| Issue | Check |
|---|---|
| 4xx/5xx | Customer API errors |
| SSRF rejection | Base URL not allowed |
| Wrong path expansion | {{email}} / {{externalId}} vs subject fields |
| Retries | Jobs may requeue retryable errors with backoff (runAfter) |