Sunnova Catalyst API Developer Portal

The Catalyst API is a REST service that enables Sunnova partners to integrate with and access Sunnova’s product offerings, services, and associated data.

With the Catalyst API, you can;

1. Perform sales actions from creating leads to generating and signing contracts.
2. Access data related to your leads, deals, and salespeople.
3. Integrate your tools to ensure seamless communication between systems.
4. Enable automation through our async processes and well-defined workflows.

Catalyst API supports and enables the end-to-end Sunnova sales process;

Getting Started

Before using Catalyst API, you’ll need to request access to it.

Once your client credentials have been provided, reference our ‘Get Started’ page to learn how to get authorized and create your first lead.

Our endpoint-specific documentation can be found here.

We also offer a mocking service that can be used to find all endpoints that are offered along with sample input, response payloads, query and URL parameters, and potential exceptions.

Endpoint Base URI

For testing

https://apitest.sunnova.com/services/v1.0

For production

https://dealerapi.sunnova.com/services/v1.0##

Webhooks

Sunnova offers proactive notifications via webhook for the specific events in the sales and installation process outlined below. These webhooks are triggered whenever there is an event or data change for the related lead, quote, or system project that is owned by the dealer.

• Lead assignment
• Lead status change
• Contact passed/declined credit
• Design as a service completion
• Project block status change.
• Contact signed contract
• System, System Project Creation Event and Change Order Conversion
• Change Order initiation, submission, rejection, and approval
• Creation of new cancellation cases

More information for each of our webhooks and their associated payload can be found here.

Sunnova’s webhooks are subscription-based, so reach out to your Dealer Sales Manager with the webhooks you’d like to subscribe to and the destination URL where the data should be sent to get started.

Sunnova’s Process flow

• Capture the lead’s information, the property installation address, and the person’s mailing address.
• Capture Utility Information Current, Proposed Rate Plan and Current Consumption.
• Build Lead System by selecting different Equipment information (Module, Inverters, tilt, azimuth etc.) and with System Addons.
• Generate Quote for the prospect using various Financing types along with Quote Addons and Pricing Methods.
• Qualify the lead by running a credit check. (Qualifying for Credit is not mandatory to Capture Utility, Build Lead System and Generate Quote, a Contact with Passed Credit is Mandatory for Generating the contract, so Running Credit can be triggered at a later point in the flow).
• Before you run credit, the person must sign a Credit Check Authorization form.
  • If they pass credit, they will become the Primary Contact and must be a signer on the contract.
  • If they do not pass credit, you will need to enter the contact details of another person and again, get authorization to run credit, and ultimately run another credit check on them.
• Once someone passes credit, you will want to make sure they are on the title to the property where the power producing system will be installed.
  • If the person who passes credit also appears on the title, you can begin generating contract.
  • If they do not appear on the title, you must enter the details of a person who is on the title and also have them sign the contract.
  • If for some reason no one is on title and dealer is not ware abt the same, and if still want to continue with contract generation, You can mark lead as Continue without title validation, so that Contract documents can be generated with out any issue.######

The matrix below provides an overview of which Pricing Method and Addons can be utilized;

Terminology

Lead: Represents the Property to which a Power Producing System will be installed as well as the initial contact information. This person may or may not live at the property address or ultimately sign a contract.

Contact: Any person whose personal contact information has been submitted in the interest of procuring a Power Producing Service Agreement.

Utility: Represents the current utility plan for Prospect and proposed Utility Plan with Solar.

Title: Represents the title information of the property, Owner on the title, type of property, etc.

Lead System: A System build used for quoting purposes. A Lead System becomes a System Project once a contract is signed by the customer.

Lead Quote: A Quote object used during the quoting process. A Lead Quote becomes an active Quote object once a contract is signed by the customer.

Primary Contact: The first signer on a contract. This is the Contact that passed credit.

Secondary Contact: The second signer on a contract. This is a person other than the person who passed credit and appears on the title in cases where the person who passed credit is not also on the title.

Adders: Applicable for Origination and Installation scenarios where a certain dollar amount can be specified and factored into quote generation for an additional service, e.g. tree trimming.

API Support

If you have a specific issue that requires support, please send an email to apisupport@sunnova.com with the following;

For API Troubleshooting

1. Summary of issue
2. Affected endpoint(s) and environment(s)
3. Request and response body in question
4. Integration user that executed the request(s)
5. Expected vs. observed behavior
6. Example request(s) or screenshots

For Webhook Troubleshooting

1. Summary of issue
2. Affected webhook(s) and environment(s)
3. Expected vs. observed behavior
4. Example payload(s) or screenshots

API Support Turnaround Time Expectation

• Initial triage within 5 business days, based on urgency/priority
• Follow-up response no later than an additional 7 business days