Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nectarclimate.com/llms.txt

Use this file to discover all available pages before exploring further.

Deprecated. Magic links have been replaced by Invitations. Invitations are revocable, auditable, support scoped email access, and are the recommended way to share a connection flow with someone else. Existing magic links continue to work for backward compatibility, but new flows should use invitations.

​
What changed?

“Magic link” was the original name for the shareable URL you could send to a recipient so they could connect a utility account on their own — either creating a new connection or re-entering credentials on an existing one. That same experience is now delivered by Invitations, which add:
  • Revocation. Invalidate a link immediately from the platform.
  • Activity log. See when the recipient viewed, verified their email, and submitted the flow.
  • Email allow-list. Restrict who can accept an invitation.
  • Resend. Resend the invitation email without generating a new link.
  • Status tracking. ACTIVE, EXPIRED, REVOKED, FULFILLED are visible in the Invitations table.
The recipient experience is unchanged — they still click a link, sign into their utility account, and Nectar starts collecting data.

​
What should I do?

  • If you’re sending new links: Use Invitations instead. Create one from Data Input > Invitations.
  • If you have outstanding magic links: They continue to work. You don’t need to migrate anything manually.
  • If you integrate via the API: See the Connection invitations developer guide for the replacement endpoints. The legacy magic-link endpoints are still available but are marked deprecated in the OpenAPI spec.

​
Where to go from here

Invitations

The replacement for magic links — revocable, auditable, and with full delivery and prefill options.

Connection invitations (API)

API reference and examples for creating contributor and reconnect invitations.