Magic link integration (deprecated)

Deprecated. The magic-link endpoints (POST /connection/company/{company_id}/link and POST /connection/{connection_id}) are marked deprecated in the OpenAPI spec. Use Connection invitations for all new integrations. Invitations are database-backed, revocable, auditable, and support scoped email access.

For platform users: see the Invitations page to understand the end-user experience.

Migration at a glance

Legacy magic-link endpoint	Invitation replacement
`POST /connection/company/{company_id}/link`	`POST /invitation/company/{company_id}`
`POST /connection/{connection_id}` (edit link)	`POST /invitation/connection/{connection_id}`
(revocation not supported)	`POST /invitation/{invitation_id}/revoke`
(list not supported)	`GET /invitation/company/{company_id}`
(detail + events not supported)	`GET /invitation/{invitation_id}`

The embed pattern is unchanged — you still display a URL in an iframe or share it directly. Only the endpoint you call on the server side is different, and the new URL format uses https://dash.nectarclimate.com/p/i/{token} instead of the legacy p/connect/... path.

Do I need to migrate existing magic links?

No. Outstanding magic-link URLs continue to work. You only need to update the endpoint your server calls when creating new links.

Legacy request and response reference

The legacy endpoints remain available for backward compatibility; the examples below are preserved for reference only.

Create a company magic link (legacy)

curl -X POST 'https://external.nectarclimate.com/v2.2/connection/company/{companyId}/link' \
  -H 'X-API-Key: YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "initialSites": ["{siteId}"] }'

Response includes publicCompanyId, companyMagicLinkSecret, and magicLinkUrl (shape: https://dash.nectarclimate.com/p/connect/{publicCompanyId}/{companyMagicLinkSecret}).

Create an edit magic link for an existing connection (legacy)

curl -X POST 'https://external.nectarclimate.com/v2.2/connection/{connectionId}' \
  -H 'X-API-Key: YOUR_SECRET_KEY'

Response includes publicCompanyId and connectionMagicLinkSecret (shape: https://dash.nectarclimate.com/p/connect/{publicCompanyId}/workflow/{connectionMagicLinkSecret}).

Next steps

Connection invitations

The recommended replacement for all magic-link use cases.

Sandbox testing

Test invitation flows with mock data.

Webhooks

Listen for connection.created.v2 and connection.updated.v2 events.

Developer onboarding

Integration patterns

API reference guides

Data model and methodology

Migration at a glance

Do I need to migrate existing magic links?

Legacy request and response reference

Next steps

Connection invitations

Sandbox testing

Webhooks

Developer onboarding

Integration patterns

API reference guides

Data model and methodology

Documentation Index

​Migration at a glance

​Do I need to migrate existing magic links?

​Legacy request and response reference

​Next steps

Connection invitations

Sandbox testing

Webhooks

Migration at a glance

Do I need to migrate existing magic links?

Legacy request and response reference

Next steps