API Reference

n8n Outbound Delivery

Recommended route-based n8n delivery model for Numora documents using the shared n8n executor and webhook notify.

Scope

This page describes the current recommended way to connect reviewed Numora documents to downstream systems with n8n.

The first provider shown in examples is dynamics365.

Numora now supports two formal delivery paths:

  • workflow: Numora-managed execution
  • n8n executor + webhook notify: external orchestration through a shared n8n webhook

If you want n8n to orchestrate the downstream write, use the second path.

Do not build new integrations around delivery outbox polling. The current model is route-based and webhook-driven.

Configuration Boundaries

1. Admin Settings

Configure the shared n8n executor once in Admin > Settings > Integrations:

  • shared webhook enabled
  • shared webhook URL
  • shared webhook secret

2. Connection Settings

Each tenant keeps its own downstream connection inside Numora.

For the current Dynamics model, the connection also carries tenant-level delivery settings such as:

  • owner team name
  • attachment target

3. Delivery Routes

Each route decides how a reviewed document is delivered:

  • workflow
  • n8n executor

When the selected route is n8n executor, the trigger mode is webhook-only.

  1. A document is extracted, reviewed, and finalized in Numora.
  2. An operator or external client calls POST /v1/documents/{id}/dispatch.
  3. Numora resolves the active delivery route for that document.
  4. If the route uses n8n executor, Numora enqueues a webhook delivery and immediately notifies the shared n8n webhook.
  5. n8n refetches the latest document state from Numora and performs the downstream write.
  6. If the downstream write happens outside Numora's managed path, record the final outcome with POST /v1/documents/{id}/delivery.

Runtime Surfaces

Dispatch

Use:

  • POST /v1/documents/{id}/dispatch

Treat 202 Accepted as "queued" rather than "completed".

Status

Use:

  • GET /v1/documents/{id}

Recommended interpretations:

  • reviewed: confirmed and ready
  • push_pending: delivery has been queued or is still running
  • push_succeeded: the latest delivery completed successfully
  • push_failed: the latest delivery attempt failed

Document Result

When n8n needs the latest structured payload, use:

  • GET /v1/documents/{id}/result

Delivery Callback

Use this only when the destination write happens outside Numora's managed execution path:

  • POST /v1/documents/{id}/delivery

The callback is idempotent by execution_id.

Dataverse Session

If n8n needs a short-lived Dynamics session without storing per-tenant client secrets, request:

  • POST /v1/dynamics/session

Reliability Model

The recommended n8n path keeps these reliability guarantees:

  • immediate webhook notify when the delivery is queued
  • cron-based retry if the first notify attempt fails
  • idempotent delivery callback recording
  • document status as the canonical completion surface

When To Use workflow Instead

Use workflow instead of n8n executor when:

  • the downstream write should stay inside Numora
  • you want Numora-managed workflow nodes to own the integration
  • you do not need external orchestration in n8n