Skip to main content
POST
curl

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-notte-request-origin
string | null
​
x-notte-sdk-version
string | null

Body

application/json
​
template_id
string
required

Connector this link collects credentials for.

​
label
string
required

Name the resulting connection is created with.

Required string length: 1 - 120
​
external_user_id
string | null

Your own identifier for the end user. Echoed back on the completion webhook.

Maximum string length: 255
​
two_fa_method
enum<string> | null

Second factor this connection will use. Required when the connector supports more than one, because the choice decides whether a mailbox is needed.

Available options:
email,
sms,
totp
​
mailbox_id
string | null

Mailbox to read email 2FA codes from. Required when the resolved method is email.

​
success_redirect_uri
string | null

Where the end user is sent once the account is connected.

​
error_redirect_uri
string | null

Where the end user is sent when the connection cannot be completed.

​
webhook_url
string | null

Receives the signed completion callback. See the connect-link webhook docs.

​
ttl_seconds
integer
default:900

How long the link stays usable.

Required range: 60 <= x <= 86400
​
schedule
boolean
default:true

Whether the resulting connection re-authenticates on a schedule.

Response

Successful Response

​
connect_link_id
string
required
​
connect_url
string
required

Send your end user here.

​
token
string
required

Returned once and never again - only its hash is stored.

​
expires_at
string<date-time>
required
​
webhook_signing_secret
string | null

Workspace secret to verify the completion webhook with. Present only when a webhook_url was supplied. Stable across links, so it is safe to store once.