All available webhook events. For details on webhooks and subscribing to events, see [Webhooks.](ref:webhooks) # `agreement_download_url_job_completed` Fires upon agreement download URL generation job completion. [block:callout] { "type": "warning", "body": "Please note that currently only jobs started from the API will trigger a webhook." } [/block] **URL Attributes** - `` - `` - `` - `` - `` **Suggested Template** ``` https://www.yourapp.com/agreement_download_url_job_completed?agreement_id=&job_id=&status=&project_id=&design_id= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | # `agreement_status_changed` Fires upon agreement status change. For a list of available statuses, see the response for "[Retrieve Agreement.](ref:getagreement)" **URL Attributes** - `` - `` - The ID of the agreement's design. - `` - `` - The ID of the selected financing option on the agreement's design. This will be empty if no financing option has been selected for the design. - `` **Suggested Template** ``` https://www.yourapp.com/agreement_status_changed?project_id=&design_id=&agreement_id=&financing_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ----------------------------------------------------------------------------------------------- | | STATUS | `sent`
`viewed`
`signed`
`cancel-pending`
`canceled`
`declined`
`error` | # `ahj_lookup_completed` Fires upon completion of an Authority Having Jurisdiction (AHJ) lookup, which happens upon <> creation to assign the project to an AHJ. The `` field can have a value of succeeded or failed, since the job sometimes fails to assign an AHJ. Please contact developer-support@aurorasolar.com if you encounter this status. **URL Attributes** - `` - `` - `` - One of `succeeded`, `failed` **Suggested Template** ``` https://www.yourapp.com/ahj_lookup_completed?project_id=&ahj_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------------ | | STATUS | `succeeded`
`failed` | # `ai_roof_job_completed` Fires upon AI Roof job completion. Currently only fires for jobs triggered from the API using "[Run AI Roof](ref:runairoof)", not for jobs triggered manually from within the application. To get more information about the job, see "[Retrieve AI Roof Status](ref:retrieveairoofstatus)". **URL Attributes** - `` - `` - `` - `` - `api` **Suggested Template** ``` https://www.yourapp.com/ai_roof_job?design_id=&job_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | # `app_status_changed` Fires upon the status of a partner application changing. The `` field can have a value of `enabled` or `disabled`. **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/app_status_changed?app_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------------ | | STATUS | `enabled`
`disabled` | # `asset_created` Fires upon an asset being created and ready for download. **URL Attributes** - `` - `` - `` - One of `Design DXF`, `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=&asset_id=&asset_type= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ASSET_TYPE | `Design DXF`
`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` | # `auto_designer_job_completed` Fires upon <> job completion. For a list of available statuses, see the response for "[Retrieve AutoDesigner job's status.](ref:retrieveautodesignerstatus)" **URL Attributes** - `` - `` - `` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/auto_designer_job_completed?design_id=&job_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | | SOURCE | `app`
`api` | # `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** - `` **Suggested Template** ``` https://www.yourapp.com/consumption_profile_changed?project_id= ``` # `design_created` Fires upon a new <> being created in Aurora. **URL Attributes** - `` - `` - `` - One of `app`, `api`, or `expert_design_service` **Suggested Template** ``` https://www.yourapp.com/design_created?project_id=&design_id=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------------------------------------- | | SOURCE | `app`
`api`
`expert_design_service` | # `design_deleted` Fires upon a <> being deleted in Aurora. **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/design_deleted?project_id=&design_id= ``` # `design_request_completed` Fires upon <> status changing to `designer_completed`. **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/design_request_completed?design_request_id=&status= ``` # `design_request_created` Fires upon <> creation. **URL Attributes** - `` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/design_request_created?design_request_id=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------ | | SOURCE | `app`
`api` | # `design_request_rejected` Fires upon <> status changing to `designer_rejected`. **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/design_request_rejected?design_request_id=&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.](ref:retrievefirepathwayplacementstatus)" [block:callout] { "type": "warning", "body": "Please note that currently only jobs started from the API will trigger a webhook." } [/block] **URL Attributes** - `` - `` - `` - `` - `api` **Suggested Template** ``` https://www.yourapp.com/fire_pathway_placement_job_completed?design_id=&job_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | | SOURCE | `api` | # `financier_contract_status_changed` Fires when a contract status changes for a financing request with an integrated financing partner (GoodLeap, LightReach, or EnFin). This event is triggered when the financier reports contract-related status changes such as contract generation, contract sent, or contract signed. For more information about the financing request, use the `` to call "[Retrieve Financing](ref:retrievefinancing)". **URL Attributes** - `` - `` - The raw status as reported by the financier. Values vary by financier. For GoodLeap, examples include `ContractUploaded`, `ContractSigned`, `AgreementSigned`, `AgreementSent`. For LightReach, examples include `contractSent`, `contractSigned`, `contractApproved`. For EnFin, examples include `PROJECT CONTRACT SENT`, `PROJECT CONTRACT SIGNED`. - `` **Suggested Template** ``` https://www.yourapp.com/financier_contract_status_changed?financing_id=&external_provider_status=&design_id= ``` # `imagery_lidar_completed` Fires upon imagery and LIDAR completion after a new project is created. Note that Aurora will automatically download default imagery and LIDAR for every new project (both using the API or in-app) in the background. This event only fires once per project when the initial default imagery and LIDAR finish loading. Subsequent changes to the imagery or LIDAR in the app will not trigger a webhook. **URL Attributes** - `` - `` - If `succeeded`, both imagery and LIDAR data are available. - If `failed`, the imagery or LIDAR data is not available. **Suggested Template** ``` https://www.yourapp.com/imagery_lidar_completed?project_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | # `milestone_created` Fires upon a new milestone being created in Aurora. The SOURCE of a milestone can be either `app` or `api` based on whether the project was created manually in Aurora, or via API. **URL Attributes** - `` - `` - `` - One of `offer`, `sold`, `installed`, `permission_to_operate`, `change_order`, `revised`, `canceled_offer`, `canceled_sold`, `canceled_installed`, `canceled_permission_to_operate`, `canceled_change_order`, `canceled_revised` - `` - One of `app`, `api` - `` _(populated only when `` is `change_order`; otherwise empty)_ - A URL-encoded, comma-separated list of one or more of: `homeowner_request`, `equipment_availability_change`, `financier_requirement`, `storage_add_on`, `design_layout_update`, `other` **Suggested Template** ``` https://www.yourapp.com/milestone_created?project_id=&design_id=&stage=&source=&change_types= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | STAGE | `offer`
`sold`
`installed`
`permission_to_operate`
`change_order`
`revised`
`canceled_offer`
`canceled_sold`
`canceled_installed`
`canceled_permission_to_operate`
`canceled_change_order`
`canceled_revised` | | SOURCE | `app`
`api` | | CHANGE_TYPES | `homeowner_request`
`equipment_availability_change`
`financier_requirement`
`storage_add_on`
`design_layout_update`
`other` | > **Note:** `` is empty for all stages except `change_order`. If you add a `CHANGE_TYPES` filter without also adding a `STAGE=change_order` filter, your webhook will stop receiving `offer`, `sold`, `installed`, and other non-change-order events. Always pair a `CHANGE_TYPES` filter with `STAGE=change_order`. # `milestone_shared` Fires upon a milestone being shared with your tenant in Aurora. The SOURCE of a milestone can be either `app` or `api` based on whether the milestone was created manually in Aurora, or via API. **URL Attributes** - `` - `` - `` - One of `offer`, `sold`, `installed`, `permission_to_operate`, `change_order`, `revised`, `canceled_offer`, `canceled_sold`, `canceled_installed`, `canceled_permission_to_operate`, `canceled_change_order`, `canceled_revised` - `` - One of `app`, `api` - `` _(populated only when `` is `change_order`; otherwise empty)_ - A URL-encoded, comma-separated list of one or more of: `homeowner_request`, `equipment_availability_change`, `financier_requirement`, `storage_add_on`, `design_layout_update`, `other` **Suggested Template** ``` https://www.yourapp.com/milestone_shared?project_id=&design_id=&stage=&source=&change_types= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | STAGE | `offer`
`sold`
`installed`
`permission_to_operate`
`change_order`
`revised`
`canceled_offer`
`canceled_sold`
`canceled_installed`
`canceled_permission_to_operate`
`canceled_change_order`
`canceled_revised` | | SOURCE | `app`
`api` | | CHANGE_TYPES | `homeowner_request`
`equipment_availability_change`
`financier_requirement`
`storage_add_on`
`design_layout_update`
`other` | > **Note:** `` is empty for all stages except `change_order`. If you add a `CHANGE_TYPES` filter without also adding a `STAGE=change_order` filter, your webhook will stop receiving `offer`, `sold`, `installed`, and other non-change-order events. Always pair a `CHANGE_TYPES` filter with `STAGE=change_order`. # `order_created` Fires upon a new consumer order being created in Aurora. **URL Attributes** - `` - Note that the order ID is an ObjectId, which is a 24-character hex string, rather than a uuid. **Suggested Template** ``` https://www.yourapp.com/order_created?order_id= ``` # `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.](ref:retrieveirradianceanalysisstatus)" **URL Attributes** - `` - `` - `` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/panel_irradiance_analysis_job_completed?design_id=&job_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | | SOURCE | `app`
`api` | # `performance_simulation_job_completed` Fires upon performance simulation job completion. **URL Attributes** - `` - `` - `` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/performance_simulation_job_completed?design_id=&job_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | | SOURCE | `app`
`api` | # `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](ref:plan-sets)" **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/plan_set_request_status_changed?plan_set_request_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------------------------------------ | | STATUS | `submitted`
`completed`
`rejected` | # `project_changed` Fires when a subset of <> 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** - `` - `` - One of `app`, `api` - `` - Comma separated list of the attributes that were modified **Suggested Template** ``` https://www.yourapp.com/project_changed?project_id=&source=&attributes= ``` | URL Parameter | Filter values | | ------------- | ------------------ | | SOURCE | `app`
`api` | # `project_created` Fires upon a new <> 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** - `` - `` - One of `app`, `api` - `` - The ID if created from a Consumer order otherwise null - Note that the order ID is an ObjectId, which is a 24-character hex string, rather than a uuid **Suggested Template** ``` https://www.yourapp.com/project_created?project_id=&source=&order_id= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------ | | SOURCE | `app`
`api` | # `project_deleted` Fires upon a <> 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** - `` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/project_deleted?project_id=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------ | | SOURCE | `app`
`api` | # `project_status_changed` Fires upon a <> status change. Unlike other webhook statuses, a project status can be any string. **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/project_status_changed?project_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ---------------- | | STATUS | any string value | # `proposal_pdf_generation_job_completed` Fires upon proposal pdf generation job completion. [block:callout] { "type": "warning", "body": "Please note that currently only jobs started from the API will trigger a webhook." } [/block] **URL Attributes** - `` - `` - `` - `` - `api` **Suggested Template** ``` https://www.yourapp.com/proposal_pdf_generation_job_completed?design_id=&job_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | # `site_survey_requested` Fires upon a site survey being requested in the Aurora app. **URL Attributes** - `` **Suggested Template** ``` https://www.yourapp.com/site_survey_requested?site_survey_request_id= ``` # `site_survey_status_changed` Fires upon a site survey status change. Currently only supports `completed` status. **URL Attributes** - `` - `` **Suggested Template** ``` https://www.yourapp.com/site_survey_status_changed?site_survey_id=&status= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------- | | STATUS | `completed` | # `utility_bill_upload_job_completed` Fires upon completion of a utility bill upload + parse job — for both bills uploaded via [Run Utility Bill Upload](ref:runutilitybillupload) and bills uploaded by users inside Aurora. Use this as a "ready to fetch" signal so you can call [Retrieve Utility Bill](ref:retrieveutilitybill) (or [List Utility Bills](ref:listutilitybills)) as soon as the bill is ready. The SOURCE can be either `app` or `api` based on whether the bill was uploaded manually in Aurora, or via API. **URL Attributes** - `` - The async job ID. For API-uploaded bills this is the value returned by [Run Utility Bill Upload](ref:runutilitybillupload). - `` - The ID of the uploaded utility bill. Use this to call [Retrieve Utility Bill](ref:retrieveutilitybill). - `` - The ID of the project the bill was uploaded to. - `` - One of `succeeded`, `failed` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/utility_bill_upload_job_completed?job_id=&utility_bill_id=&project_id=&status=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | --------------------------- | | STATUS | `succeeded`
`failed` | | SOURCE | `app`
`api` | # `web_proposal_url_created` Fires upon a web proposal URL being generated or re-generated. The SOURCE of a <> can be either `app` or `api` based on whether the Web Proposal URL was generated manually in Aurora, or via API. **URL Attributes** - `` - `` - One of `app`, `api` **Suggested Template** ``` https://www.yourapp.com/web_proposal_url_created?design_id=&source= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ------------------ | | SOURCE | `app`
`api` | # `web_proposal_viewed` Fires when a web proposal is viewed. Fires on every view; use the `` filter if you only want to be notified the first time a given proposal is viewed. Repeat views of the same proposal within a short window are debounced into a single delivery. **URL Attributes** - `` - `` - `` - One of `true`, `false` **Suggested Template** ``` https://www.yourapp.com/web_proposal_viewed?design_id=&project_id=&is_first_view= ``` **Filters Available** | URL Parameter | Filter values | | ------------- | ---------------------- | | IS_FIRST_VIEW | `true`
`false` |