All available webhook events. For details on webhooks and subscribing to events, see Webhooks.

agreement_status_changed

Fires upon agreement status change. For a list of available statuses, see the response for "Retrieve Agreement."

URL Attributes

• <PROJECT_ID>
• <AGREEMENT_ID>
• <STATUS>

Suggested Template

https://www.yourapp.com/agreement_status_changed?project_id=<PROJECT_ID>&agreement_id=<AGREEMENT_ID>&status=<STATUS>

Filters Available

ahj_lookup_completed

Fires upon completion of an Authority Having Jurisdiction (AHJ) lookup, which happens upon project creation to assign the project to an AHJ. The <STATUS> field can have a value of succeeded or failed, since the job sometimes fails to assign an AHJ. Please contact [email protected] if you encounter this status.

URL Attributes

• <PROJECT_ID>
• <AHJ_ID>
• <STATUS>
  • One of succeeded, failed

Suggested Template

https://www.yourapp.com/ahj_lookup_completed?project_id=<PROJECT_ID>&ahj_id=<AHJ_ID>&status=<STATUS>

Filters Available

app_status_changed

Fires upon the status of a partner application changing. The <STATUS> field can have a value of enabled or disabled.

URL Attributes

• <APP_ID>
• <STATUS>

Suggested Template

https://www.yourapp.com/app_status_changed?app_id=<APP_ID>&status=<STATUS>

Filters Available

asset_created

Fires upon an asset being created and ready for download.

URL Attributes

• <DESIGN_ID>
• <ASSET_ID>
• <ASSET_TYPE>
  • One of Design DXF, Design Layout, CAD Screenshot, CAD Auto Screenshot, Site Survey Request Screenshot, Racking Spec Sheet, Racking Install Manual, Racking Certification, Racking CAD File, Racking Engineering Report, Racking Bill of Materials

Suggested Template

https://www.yourapp.com/asset_created?design_id=<DESIGN_ID>&asset_id=<ASSET_ID>&asset_type=<ASSET_TYPE>

Filters Available

auto_designer_job_completed

Fires upon AutoDesigner job completion. For a list of available statuses, see the response for "Retrieve AutoDesigner job's status."

URL Attributes

• <DESIGN_ID>
• <JOB_ID>
• <STATUS>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/auto_designer_job_completed?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>&source=<SOURCE>

Filters Available

consumption_profile_changed

Fires upon any change to a consumption profile. Note that the change may not affect any fields exposed through the API.

URL Attributes

• <PROJECT_ID>

Suggested Template

https://www.yourapp.com/consumption_profile_changed?project_id=<PROJECT_ID>

design_created

Fires upon a new design being created in Aurora.

URL Attributes

• <PROJECT_ID>
• <DESIGN_ID>
• <SOURCE>
  • One of app, api, or expert_design_service

Suggested Template

https://www.yourapp.com/design_created?project_id=<PROJECT_ID>&design_id=<DESIGN_ID>&source=<SOURCE>

Filters Available

design_deleted

Fires upon a design being deleted in Aurora.

URL Attributes

• <PROJECT_ID>
• <DESIGN_ID>

Suggested Template

https://www.yourapp.com/design_deleted?project_id=<PROJECT_ID>&design_id=<DESIGN_ID>

design_request_completed

Fires upon design request status changing to designer_completed.

URL Attributes

• <DESIGN_REQUEST_ID_IN_AURORA>
• <STATUS>

Suggested Template

https://www.yourapp.com/design_request_completed?design_request_id=<DESIGN_REQUEST_ID_IN_AURORA>&status=<STATUS>

design_request_created

Fires upon design request creation.

URL Attributes

• <DESIGN_REQUEST_ID>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/design_request_created?design_request_id=<DESIGN_REQUEST_ID>&source=<SOURCE>

Filters Available

design_request_rejected

Fires upon design request status changing to designer_rejected.

URL Attributes

• <DESIGN_REQUEST_ID_IN_AURORA>
• <STATUS>

Suggested Template

https://www.yourapp.com/design_request_rejected?design_request_id=<DESIGN_REQUEST_ID_IN_AURORA>&status=<STATUS>

fire_pathway_placement_job_completed

Fires upon fire pathway placement job completion. For a list of available statuses, see the response for "Retrieve fire pathway placement job's Status."

🚧

Please note that currently only jobs started from the API will trigger a webhook.

URL Attributes

• <DESIGN_ID>
• <JOB_ID>
• <STATUS>
• <SOURCE>
  • api

Suggested Template

https://www.yourapp.com/fire_pathway_placement_job_completed?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>&source=<SOURCE>

Filters Available

lead_changed

Fires upon a lead being changed in Aurora.

URL Attributes

• <LEAD_ID>

Suggested Template

https://www.yourapp.com/lead_changed?lead_id=<LEAD_ID>

lead_converted

Fires upon a lead being converted into a project in Aurora.

URL Attributes

• <LEAD_ID>
• <PROJECT_ID>

Suggested Template

https://www.yourapp.com/lead_converted?lead_id=<LEAD_ID>&project_id=<PROJECT_ID>

lead_created

Fires upon a new lead being created in Aurora. The SOURCE of a lead can either be lcai or api based on if the lead was made through LCAI or manually via API.

URL Attributes

• <LEAD_ID>
• <SOURCE>
  • One of lcai, api

Suggested Template

https://www.yourapp.com/lead_created?lead_id=<LEAD_ID>&source=<SOURCE>

Filters Available

lead_solar_estimation_job_completed

Fires upon a lead’s Solar Estimation job completion. For a list of available statuses, see the response for "Retrieve Solar Estimation job's status."

URL Attributes

• <LEAD_ID>
• <JOB_ID>
• <STATUS>

Suggested Template

https://www.yourapp.com/lead_solar_estimation_job_completed?lead_id=<LEAD_ID>&job_id=<JOB_ID>&status=<STATUS>

Filters Available

panel_irradiance_analysis_job_completed

Fires upon irradiance analysis job completion. Note that this will only send once panel irradiance is completed, and will not send for roof irradiance jobs. For a list of available statuses, see the response for "Retrieve irradiance analysis job's status."

URL Attributes

• <DESIGN_ID>
• <JOB_ID>
• <STATUS>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/panel_irradiance_analysis_job_completed?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>&source=<SOURCE>

Filters Available

performance_simulation_job_completed

Fires upon performance simulation job completion.

URL Attributes

• <DESIGN_ID>
• <JOB_ID>
• <STATUS>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/performance_simulation_job_completed?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>&source=<SOURCE>

Filters Available

plan_set_request_status_changed

Fires upon a plan set request status change. For a list of available statuses, see the documentation for "Plan Sets"

URL Attributes

• <PLAN_SET_REQUEST_ID>
• <STATUS>

Suggested Template

https://www.yourapp.com/plan_set_request_status_changed?plan_set_request_id=<PLAN_SET_REQUEST_ID>&status=<STATUS>

Filters Available

project_changed

Fires when a subset of project attributes are modified. The SOURCE can be either app or api based on whether the project was modified manually in Aurora, or via API.

This webhook will fire when any of the following attributes are updated:

• ahj_id
• customer_address
• customer_email
• customer_first_name
• customer_last_name
• customer_phone
• customer_salutation
• name
• owner_id
• status
• team_id

URL Attributes

• <PROJECT_ID>
• <SOURCE>
  • One of app, api
• <ATTRIBUTES>
  • Comma separated list of the attributes that were modified

Suggested Template

https://www.yourapp.com/project_changed?project_id=<PROJECT_ID>&source=<SOURCE>&attributes=<ATTRIBUTES>

project_created

Fires upon a new project being created in Aurora. The SOURCE of a project can be either app or api based on whether the project was created manually in Aurora, or via API.

URL Attributes

• <PROJECT_ID>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/project_created?project_id=<PROJECT_ID>&source=<SOURCE>

Filters Available

project_deleted

Fires upon a project being deleted in Aurora. The SOURCE of a project can be either app or api based on whether the project was deleted manually in Aurora, or via API.

URL Attributes

• <PROJECT_ID>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/project_deleted?project_id=<PROJECT_ID>&source=<SOURCE>

Filters Available

project_status_changed

Fires upon a project status change. Unlike other webhook statuses, a project status can be any string.

URL Attributes

• <PROJECT_ID>
• <STATUS>

Suggested Template

https://www.yourapp.com/project_status_changed?project_id=<PROJECT_ID>&status=<STATUS>

Filters Available

site_survey_requested

Fires upon a site survey being requested in the Aurora app.

URL Attributes

• <SITE_SURVEY_REQUEST_ID>

Suggested Template

https://www.yourapp.com/site_survey_requested?site_survey_request_id=<SITE_SURVEY_REQUEST_ID>

site_survey_status_changed

Fires upon a site survey status change. Currently only supports completed status.

URL Attributes

• <SITE_SURVEY_ID>
• <STATUS>

Suggested Template

https://www.yourapp.com/site_survey_status_changed?site_survey_id=<SITE_SURVEY_ID>&status=<STATUS>

Filters Available

web_proposal_url_created

Fires upon a web proposal URL being generated or re-generated. The SOURCE of a project can be either app or api based on whether the Web Proposal URL was generated manually in Aurora, or via API.

URL Attributes

• <DESIGN_ID>
• <SOURCE>
  • One of app, api

Suggested Template

https://www.yourapp.com/web_proposal_url_created?design_id=<DESIGN_ID>&source=<SOURCE>

Filters Available