For the complete documentation index, see llms.txt. This page is also available as Markdown.

Signed token API

Generate a pre-signed sign-in URL for an embedded user. Open the URL, or load it in an iframe, and the user lands in Nected already signed in, with no separate login step.

Before you call this API, add the person as an embedded user: go to Workspace settings → Embedded Users, enter their email, choose a role and click Add User. The full setup, including iframe embedding, hiding features and logout, is in the Embeddable View guide.

Generate an embedded sign-in URL

get

Returns a pre-signed sign-in URL for the given user email.

The URL expires 5 minutes after it is issued. Generate it just before you need it, and call this endpoint again to get a fresh URL.

To land the user on a specific page after sign-in, append a path to the redirect query parameter of the returned URL, for example redirect=/rules or redirect=/workflow.

Query parameters
emailstring · emailRequired

Email address of the embedded user the URL is issued for.

Header parameters
Nected-API-KeystringRequired

Your Nected API key.

Responses
200

OK

application/json
codestringRequiredExample: success
messagestringRequiredExample: Success.
get/dev/v1/signed-token
GET /dev/v1/signed-token?email=name%40gmail.com HTTP/1.1
Host: api.nected.ai
Nected-API-Key: text
Accept: */*
{
  "code": "success",
  "message": "Success.",
  "data": {
    "signedURL": "https://app.nected.ai/redirect/signed-url/<SIGNED_TOKEN>?redirect="
  }
}

Good to know

  • The URL expires after 5 minutes. Generate it right before you use it, don't store or cache it, and request a new one for each session.

  • Choose the landing page with the redirect parameter on the returned URL. Use /rules for rule management or /workflow for the workflow dashboard.

  • Iframe embedding works on self-hosted deployments only. SaaS deployments can't embed Nected in an iframe because of cross-domain restrictions.

  • Keep your API key on your server. Call this API from your backend, never from browser code.

If a user opens a URL that has expired, they'll see an invalid signed token error. Call this API again for a new URL.

Read More

Last updated