Integrations Overview

Connect Neostra with your existing systems through REST APIs, external service integrations, and the cookie consent widget.

Overview

Neostra integrates with external systems at multiple levels: REST APIs for programmatic access, pre-built connectors for CRM and marketing platforms, cloud storage for file handling, and embeddable widgets for consent collection.

REST APIs

400+ endpoints across 6 services with JWT authentication, pagination, and standardized response formats.

Cookie Consent Widget

CDN-hosted Svelte widget that embeds on any website with a single script tag.

External Connectors

Pre-built integrations with CRM, email, and marketing platforms.

Supported Integrations

Neostra's Integration module (managed via /api/v1/integration/) supports connecting to external platforms for automated data operations like enforcing opt-outs or syncing consent preferences.

Platform	Capabilities
Gmail SMTP (Google Workspace)	Transactional emails — invites, password resets, verifications, task reminders via SMTP relay
Mailchimp	Audience sync, consent-based list management
HubSpot	Contact sync, consent preference enforcement

Platform	Capabilities
Salesforce	Data subject record lookup, opt-out enforcement
Generic API	Custom REST API integration for any downstream system

Create an integration:

curl -X POST https://api.neostra.io/v1/integration/create \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My CRM Integration",
    "type": "generic_api",
    "config": {
      "baseUrl": "https://your-crm.com/api",
      "authType": "bearer",
      "token": "crm-api-token"
    }
  }'

Provider	Buckets / Config
Google Cloud Storage	File uploads, published privacy pages, attachments, conversation files
AWS S3	Published privacy pages (EU region for data sovereignty)

File upload endpoint (public, max 10MB per file):

curl -X POST https://api.neostra.io/v1/storage/file-upload \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "file=@document.pdf"

Data Discovery Connectors

The Data Discovery module connects to enterprise data sources for automated PII scanning:

Data Source	Protocol	Scanner Support
PostgreSQL	JDBC	Full scan + column-level PII detection
MySQL	JDBC	Full scan + column-level PII detection
MongoDB	MongoDB Driver	Collection-level scanning
AWS S3	AWS SDK	Object scanning (CSV, JSON, PDF)
AWS DynamoDB	AWS SDK	Table scanning

Configure a data source integration:

curl -X POST https://api.neostra.io/v1/integrations \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Database",
    "type": "postgresql",
    "config": {
      "host": "db.internal.company.com",
      "port": 5432,
      "database": "production",
      "username": "readonly_user"
    }
  }'

Database credentials are encrypted at rest using AES encryption before storage. The scanner uses these credentials only during active scans.

Webhook-Style Automation

While Neostra does not expose a traditional webhook system, automated actions are triggered through:

Workflow Rules: Configure workflow stages to call external APIs when requests reach specific stages
Integration Actions: Trigger downstream CRM or ad platform API calls to enforce user opt-outs automatically
Email Notifications: SMTP-based notifications triggered by request lifecycle events (creation, assignment, completion, reminders)

Service-to-Service Communication

For internal microservice communication, Neostra uses private key authentication:

Service	Config Key	Purpose
cpmp-api-service	`CONSENT_API_PRIVATE_KEY`	Consent operations from core
cpmp-crawler-service	`CRAWLER_SERVICE_PRIVATE_KEY`	Cookie scanning requests
data-discovery-boot	`discProxyRequestPrivateKey`	Data inventory queries

Next Steps

Cookie Consent Modal

Embed the consent banner on your website.

REST API Patterns

Learn the standard request/response patterns across all APIs.

Was this page helpful?

Last updated 4 weeks ago

Built with Documentation.AI