Partner API Keys: credentials and callbacks

Create credentials in the panel, protect the API Key and Webhook Secret, and configure optional callbacks with HTTPS and a circuit breaker.

In this guide you will…

  1. Understand what the partner integration does in N1
  2. Find the Partner API Keys card in Settings
  3. Create and safely store an API Key and Webhook Secret
  4. Manage keys and optional callbacks

What this integration does

In plain terms: a partner (an external system) can send orders into your N1 operation over the API. Optionally, N1 can notify the partner when an order status changes (shipped or delivered, for example), if you configure an HTTPS callback.

Where to find it

  1. Open the side menu and click Settings
  2. Select the Settings tab
  3. In the cards area of the page, find the Partner API Keys card (there is a Create button next to the title)

The card's supporting text reads Send your orders over the API.

Step by step — creating the key

  1. Click Create on the Partner API Keys card
  2. Fill in Integration Name — an internal name to identify the integration (for example, the platform's name)
  3. Fill in Partner Identifier — it must be unique within the operation and becomes part of the order ID. Lowercase letters, numbers, underscore (_) and hyphen (-) are allowed; other characters are adjusted automatically. Maximum 50 characters
  4. Click Create API Key
  5. The API Key Credentials modal opens with the API Key and Webhook Secret. Copy and store them somewhere safe right away — the full credentials are shown only once

What to do with the API Key and Webhook Secret

  • Store them in a password vault or your team's secret manager
  • Pass them to the technical team over a secure channel
  • Do not post them in open tickets, group chats or repositories

The Webhook Secret is used for the integration's cryptographic signatures (sending and receiving webhooks). Whoever implements the API needs it to sign and validate requests.

Managing the list

For each key you can see the name, identifier, status (Active/Inactive), last use and callback information where present. The main actions:

  • Toggle: enable or disable the key without deleting it
  • Webhook icon: opens Status Callback (HTTPS URL, enable, attempts, test)
  • Regenerate Secret: generates a new secret — integrations still using the old one stop authenticating until they are updated
  • Remove: deletes the key permanently

Callbacks (optional)

For N1 to notify the partner's system when an order status changes:

  1. The URL must be HTTPS (the interface requires a URL starting with https://)
  2. Click the webhook icon on the key's row to open Status Callback
  3. Enter the URL, mark whether the callback is active and set the number of attempts on failure
  4. Use Test Callback to validate the endpoint before relying on it in production
  5. Circuit breaker: after many consecutive failures, sending may be paused automatically. The panel shows Circuit breaker tripped and a Reactivate button once the endpoint is fixed

Next step

Technical guide (endpoints, inbound/outbound HMAC, errors): Partner API — technical guide.

The JSON documentation for the callback (outbound) format is at: https://YOUR-N1-DOMAIN.com/api/webhooks/partner/docs — use the same host as your N1 instance (where you access the panel).