Skip to main content
Integrations

Soryxa Webhooks and Connectors

Connect Soryxa validation decisions to other systems with scoped API tokens, inbound validation webhooks, outbound event delivery, OpenAPI, and Postman assets.

Integration model

API token scopes Limit direct API access to validate, usage, or explicit legacy scope behavior.
connector scopes Control whether a connector can trigger validation, read results, or receive review events.
validation.completed Deliver event payloads into systems that can verify and process HTTPS JSON.

API token scopes

Create separate production, staging, and development tokens where useful. New tokens should use the smallest scope set that covers the endpoints they call.

Scope Access
validate POST /api/v1/validate and all /api/v1/batch endpoints.
usage GET /api/v1/usage for current usage and remaining validation allowance.
Empty scopes Legacy full-access tokens. Prefer explicit scopes for new production tokens.

Token lifecycle

A team can keep up to 10 active tokens, label each for production, staging, or development, assign validate and usage scopes, and revoke a token individually.

Token policy controls

A new token value is displayed once and masked after you leave or refresh. Optional controls set a per-token requests-per-minute limit and a rotation reminder from 1 to 365 days.

Usage visibility

Send GET /api/v1/usage with a bearer token carrying the usage scope to read current plan usage without consuming a validation credit.

Inbound webhook path

Inbound connector webhooks use the integration slug and team public UUID. They can validate a direct email field or a nested action/data payload, and signed connectors are verified before work is queued.

POST /api/v1/integrations/webhook/{teamPublicUuid}/{slug}
Content-Type: application/json

{
  "action": "validate",
  "data": {
    "email": "user@example.com"
  }
}

Direct payloads with email or email_address are also accepted by connector-specific handlers where supported.

Outbound event shape

Store event IDs in receiving systems so duplicate deliveries can be handled safely. Inbound validate actions require an active outbound or bidirectional connector with read_results to receive results.

{
  "event": "validation.completed",
  "data": {
    "email": "user@example.com",
    "decision": "allow",
    "reason_code": "CLASSIFICATION_VALID",
    "score": 96
  }
}

Webhook events

Webhook receivers should verify the sender, parse event type, and keep validation decisions separate from delivery failures. Failed outbound deliveries are tracked for retry and dead-letter handling.

validation.completed

Configured outbound connectors receive a completed validation decision.

validation.failed

Configured outbound connectors receive a validation failure that needs fallback handling.

batch.completed

Configured outbound connectors receive a completed batch summary.

review.approved

Connectors with the review_decisions scope receive an approved review outcome.

review.rejected

Connectors with the review_decisions scope receive a rejected review outcome.

Connector scopes

Connector scopes are separate from API token scopes. Choose scopes based on whether the connector receives events, triggers validation, or both.

Connector scope Access
validate Allows inbound or bidirectional connectors to trigger Soryxa validation.
read_results Allows outbound connectors to receive validation result data where supported.
read_usage Allows connectors to read usage and allowance information where supported.
review_decisions Allows outbound connectors to receive review queue decision events where supported.

Supported connectors

Connector availability may depend on account configuration and provider setup. Custom webhook is the most direct pattern for systems that can receive HTTPS JSON events.

Zapier

Trigger no-code workflows from Soryxa validation and batch events.

Make

Connect Soryxa events to Make scenarios for routing, alerts, and record updates.

n8n

Use Soryxa decisions inside self-hosted or managed n8n workflows.

Auth0

Use email-quality decisions in identity and signup-related workflows where configured.

Clerk

Use Soryxa validation from Clerk webhook or server-side signup handlers.

Supabase Auth

Use Soryxa validation with Supabase Auth signup or auth-hook workflows.

Firebase Auth

Use Soryxa validation with Firebase authentication workflows.

NextAuth

Use Soryxa validation in NextAuth or Auth.js server-side signup flows.

Laravel

Use Soryxa validation in Laravel app signup and account intake flows.

Custom webhook

Send Soryxa events to any HTTPS endpoint that can verify the request and process JSON payloads.

Developer assets

Use the OpenAPI file to generate clients or review response schemas. Use the Postman collection, workspace manifest, and environment file for a quick authenticated request from a local workspace. These four asset URLs require an authenticated Soryxa browser session.

The Postman collection includes runnable requests named Validate Email, Get Usage, Create Batch, List Batch Jobs, Get Batch Status, Get Batch Results, Export Batch Results, Get Batch Credits, Cancel Batch, and Trigger Integration Webhook.

Signed-in activation checklist

The activation screen tracks six setup steps: API token, published policy, playground decision, usage-log verification, Postman collection, and protected form proxy.