Back to API Overview

Integration Setup Tutorial

Everything you need before you can start sending documents for signature via the API.

Receiving Webhook Notifications

Optional

You can send documents via API without webhooks. Webhooks add real-time notifications when signing events occur.

Overview

When a signing session changes state, NomaSign delivers an HMAC-signed POST to your configured webhook endpoint. Your server verifies the signature and processes the event.

Prerequisites

  • Your Webhook Secret (generated in Step 4)

Local Development with Dev Tunnels

To receive webhooks locally, you need a public URL that tunnels to your backend.

VS Code UI (Easiest)

  1. Open the Ports panel (Terminal → Ports tab)
  2. Click Forward a Port → enter 5203
  3. Set visibility to Public (right-click → Port Visibility → Public)
  4. Copy the URL (e.g. https://abc123-5203.euw.devtunnels.ms)
  5. Set webhook URL to: <tunnel-url>/api/signing/webhooks/nomasign

CLI

devtunnel user login
devtunnel host -p 5203 --allow-anonymous

Set webhook URL to: <tunnel-url>/api/signing/webhooks/nomasign

Configuring in NomaSign

  1. Go to Integration page in the NomaSign web app
  2. Edit your integration entry
  3. Set your Webhook URL (must be HTTPS)
  4. Use Send Test Event to verify your endpoint works

Step 1: Create a tunnel in VS Code

Start a new dev tunnel in VS Code so your local webhook endpoint can be reached from the internet.

Webhook setup step one

Step 2: Add the port to the tunnel

Add your local backend port to the tunnel configuration so webhook requests can route to your app.

Webhook setup step two

Step 3: Make the tunnel public

Change tunnel visibility to public so NomaSign can deliver webhook events to your endpoint.

Webhook setup step three

Step 4: Copy the tunnel URL and add it to your integration

Copy your tunnel URL and paste it into the integration's webhook URL field.

Webhook setup step four

Verifying It Works

  1. Start your backend (dotnet run)
  2. Start the tunnel
  3. Set webhook URL in NomaSign to tunnel URL + /api/signing/webhooks/nomasign
  4. Click Send Test Event in NomaSign
  5. Check backend logs for the received event

Setup complete!

You're ready to run the example app and start building your integration.