Nimriz

Developer integrations

Build Nimriz into the systems your team owns.

Create and manage branded links, record backend conversion outcomes, and react to signed lifecycle events through production-oriented interfaces.

Read API docsCompare build paths
Your backend
Service, job, or internal tool
API access
Conversion API
Signed lifecycle webhooks
Choose one path or combine all three.

Build paths

Choose the contract that matches the job.

01

API access

Create and manage branded links from backend services, internal tools, and product workflows.

Best for: Link operations owned by your application
  • Create single or bulk links
  • Check and update domain-bound slugs
  • Manage expiration and link protection
Read API docs →
02

Conversion API

Send attributed conversion events from your backend while keeping the Nimriz touchpoint in the event model.

Best for: Backend outcomes that need click attribution
  • Use a separate signing secret
  • Send server-side conversion outcomes
  • Keep campaign and touchpoint context connected
Explore Conversion API →
03

Signed lifecycle webhooks

Receive signed link and workspace events with retry and replay controls for code-owned workflows.

Best for: Systems that react when Nimriz resources change
  • Subscribe to selected lifecycle events
  • Verify HMAC-SHA256 signatures
  • Inspect deliveries and replay failures
Explore webhooks →

Request lifecycle

A predictable path from request to outcome.

Each integration path has its own credential and payload contract, while workspace and domain rules stay consistent across the platform.

  1. 01

    Authenticate

    Use the credential designed for the path: a workspace API key, a Conversion API signing secret, or a webhook signing secret.

  2. 02

    Address the workspace

    Operate against the selected workspace and domain. Link uniqueness stays bound to the chosen domain and short code.

  3. 03

    Apply the operation

    Create or update a link, record a conversion outcome, or consume a lifecycle event in your own system.

  4. 04

    Handle the result

    Use stable identifiers, explicit response codes, and documented retry behavior to keep integrations predictable.

Production contract

Build around explicit safety rules.

  • Generate branded campaign links from internal tools.
  • Receive signed link and domain lifecycle events in your backend.
  • Route click, scan, card, and conversion events through destinations such as Generic HTTP.
  • Review authentication, rate limits, and privacy behavior before implementation.

Credentials stay server-side

Workspace keys and signing secrets belong in a trusted backend, never in browser code, mobile apps, or public repositories.

Domain rules stay explicit

Host matching is strict, reserved paths remain protected, and redirects use 302 unless a link is explicitly configured for 301.

Retries stay safe

Bulk link creation supports stable idempotency keys, while lifecycle webhooks use stable event IDs for deduplication.

Delivery stays inspectable

Webhook attempts expose delivery history, test sends, replay controls, and signing-secret rotation for ongoing operations.

Implementation resources

Move from architecture to implementation.

Browse all docs →

Create and manage links

Use the API reference for link creation, custom slugs, domains, and automation paths.

API reference →

Authenticate requests

Review API authentication before wiring server-side workflows or internal tools.

Authentication docs →

Handle webhooks

Review signed deliveries, event schemas, retry behavior, and replay paths.

Webhook docs →

Connect destinations

Route events to analytics, ad, automation, HTTP, and webhook destinations.

Integrations →

Review rate limits and errors

Check rate-limit and error handling expectations before production use.

Rate limits →

Review trust and privacy

Use trust and security pages for analytics privacy, redirect safety, and abuse paths.

Trust →

Start building

Connect your backend to Nimriz.

Review authentication and API contracts, then choose the integration path that fits your system.

Review authenticationExplore AI tools