Custom Roles
You can now assign custom roles when managing user accounts via Users API. With the addition of role_id field to Create User, Invite User, and Update User endpoints, you can assign a user to one of the global roles (e.g., “Team Member”) or a custom role defined for the tenant. To look up role ids, you can use the newly added List Roles endpoint.
API Version 2022.09
Aurora releases a new API version when we make backward-incompatible changes. To avoid disrupting your integration and breaking your code, we don’t change your version automatically. You can upgrade to the latest version using Versions API when you are ready. The following are breaking changes in version 2022.09 released today.
Enhanced Simulation Webhooks
Completed Irradiance Analysis, AutoDesigner, and Performance Simulation jobs from Sales Mode and Pro Mode now trigger webhooks. Previously, only jobs started via API did. With the enhanced webhooks, you can build applications that respond in real-time to user activity in Aurora (e.g. retrieve design summary when a user presses the “Recalculate” button in Sales Mode). The enhanced webhooks are available in both Aurora and legacy Aurora.
Roof Summary API: Face Azimuth and Modules Area
You now have access to two additional fields in Retrieve Roof Summary API: roof face azimuth and the total area of modules on the roof. With the area of modules, for example, you can provide more accurate estimates for projects involving solar tiles or solar panels integrated into the roof.
Webhook Filters
With webhook filters, you have fine control over which events in your Aurora tenant to notify your applications. The filters are a list of webhook URL attributes and their values that would cause webhooks to fire. You can apply filters to one or more URL attributes of any webhook event. For example, adding "filters": {"<STATUS>": ["sold", "plant_set_completed"]}
to a project_status_changed webhook subscription would cause the webhooks to fire only after the project status changes to one of the two values.
SSO Provider API
You can now configure single sign-on (SSO) access for your Aurora users via an API. The SSO access enables your team members to log in to Aurora with the same credentials they use in the rest of your IT ecosystem. With the new SSO Provider API endpoints, you can self-configure your Aurora tenant to use an identity provider that supports the OpenID Connect protocol (e.g. Salesforce, Okta, Duo Security). For detailed instructions, check out the Configure Single Sign-On tutorial.
AutoDesigner API: Minimum TSRF / SAP in Energy Mode
You can now specify a minimum Total Solar Resource Fraction (TSRF) or Solar Access Percentage (SAP) in Energy Mode (previously this parameter was available in Max Fit only). If the TSRF or SAP of a given panel location is below the threshold, no panel will be placed.
“Project Created” Webhook Event
You can now trigger project_created webhooks when a new project is created in Aurora. The webhook payload includes , enabling you to determine if the project was created from the Aurora app or an API. With the new webhook event, you can be assured that your IT ecosystem always has complete and up-to-date project information regardless of how the project was created in Aurora.
Leads API: Marketing URL parameter and template identification fields
The Retrieve Lead API now includes three new fields intended to make it easier to track the source of incoming leads. The new fields are marketing URL parameters from Lead Capture AI leads (referrer_params
) plus identifying information for the Lead Capture template (template_id
and template_name
).
AutoDesigner API: Minimum Contiguous Panels in Energy Mode
You can now specify a minimum number of contiguous panels in a row (rack) in AutoDesigner API. Increasing this number can reduce the cost of installation and the aesthetic appeal of your system. However, keep in mind that Energy Mode already optimizes production and cost, and avoids having rows with very few panels when possible. If you make the minimum too high, it might result in a less than optimal system or even make it impossible to meet your energy target.