---
title: "Update Webhook"
method: PUT
path: "/tenants/{tenant_id}/webhooks/{webhook_id}"
tags: ["Webhooks"]
---

# Update Webhook

`PUT /tenants/{tenant_id}/webhooks/{webhook_id}`

Update properties of a single webhook.

## Path parameters

- `tenant_id` string, uuid, required
- `webhook_id` string, uuid, required

## Request body

- object
  - `webhook` object, required — Webhook to update.
    - `event` 'agreement_status_changed' | 'ahj_lookup_completed' | 'ai_roof_job_completed' | 'app_status_changed' | 'asset_created' | 'auto_designer_job_completed' | 'consumption_profile_changed' | 'design_created' | 'design_deleted' | 'design_request_completed' | 'design_request_created' | 'design_request_rejected' | 'eagleview_design_request_created' | 'eagleview_design_request_status_changed' | 'fire_pathway_placement_job_completed' | 'imagery_lidar_completed' | 'milestone_created' | 'milestone_shared' | 'order_created' | 'panel_irradiance_analysis_job_completed' | 'performance_simulation_job_completed' | 'plan_set_request_status_changed' | 'project_changed' | 'project_created' | 'project_deleted' | 'project_status_changed' | 'agreement_download_url_job_completed' | 'utility_bill_upload_job_completed' | 'proposal_pdf_generation_job_completed' | 'site_survey_requested' | 'site_survey_status_changed' | 'web_proposal_url_created' | 'financier_contract_status_changed' — The Aurora event which triggers the webhook to fire.
    - `url_template` string — URL template that GET requests are sent to when the event occurs
    - `description` string — Description of the webhook's purpose.
    - `enabled` boolean — Whether the GET request will be sent on the next event occurrence. Default true.
    - `header_auth_key` string — Name of the HTTP header used for authentication to the url specified in url_template. Must be provided with header_auth_value or omitted; must not be provided with basic_auth_username or basic_auth_password.
    - `header_auth_value` string — Value of the HTTP header used for authentication to the url specified in url_template. Must be provided with header_auth_key or omitted; must not be provided with basic_auth_username or basic_auth_password.
    - `basic_auth_username` string — Username for authentication via basic auth to the url specified in url_template. Must be provided if basic_auth_password is provided; must not be provided with header_auth_key or header_auth_value.
    - `basic_auth_password` string — Password for authentication via basic auth to the url specified in url_template. Must not be provided with header_auth_key or header_auth_value.
    - `filters` object[] — The [Filters](https://docs.aurorasolar.com/reference/webhooks#filters) applied to this webhook. If multiple filters are supplied, all must be satisfied for the webhook to be triggered.
      - `url_parameter` '<STATUS>' | '<SOURCE>' | '<ASSET_TYPE>' | '<STAGE>' | '<CHANGE_TYPES>', required — The URL parameter used to filter the webhook, including the brackets.
      - `values` string[], required — The list of values; if the URL parameter matches any value in the array, the webhook will be triggered.

## Response `200`

Webhook successfully updated.

- object
  - `webhook` object, required
    - `id` string, uuid, required — Unique ID identifying the webhook.
    - `description` string, required — Description of the webhook's purpose.
    - `event` 'agreement_status_changed' | 'ahj_lookup_completed' | 'ai_roof_job_completed' | 'app_status_changed' | 'asset_created' | 'auto_designer_job_completed' | 'consumption_profile_changed' | 'design_created' | 'design_deleted' | 'design_request_completed' | 'design_request_created' | 'design_request_rejected' | 'eagleview_design_request_created' | 'eagleview_design_request_status_changed' | 'fire_pathway_placement_job_completed' | 'imagery_lidar_completed' | 'milestone_created' | 'milestone_shared' | 'order_created' | 'panel_irradiance_analysis_job_completed' | 'performance_simulation_job_completed' | 'plan_set_request_status_changed' | 'project_changed' | 'project_created' | 'project_deleted' | 'project_status_changed' | 'agreement_download_url_job_completed' | 'utility_bill_upload_job_completed' | 'proposal_pdf_generation_job_completed' | 'site_survey_requested' | 'site_survey_status_changed' | 'web_proposal_url_created' | 'financier_contract_status_changed', required — The Aurora event which triggers the webhook to fire.
    - `url_template` string, required — URL template that GET requests are sent to when the event occurs.
    - `enabled` boolean, required — Whether the GET request will be sent on the next event occurrence.
    - `credentials_enabled` boolean, required — Whether credentials are attatched to this webhook.
    - `created_at` string, date-time, required — Timestamp when the webhook was created in UTC
    - `updated_at` string, date-time, required — Timestamp when the webhook was last updated in UTC
    - `filters` object[], required — The [Filters](https://docs.aurorasolar.com/reference/webhooks#filters) applied to this webhook. If multiple filters are supplied, all must be satisfied for the webhook to be triggered.
      - `url_parameter` '<STATUS>' | '<SOURCE>' | '<ASSET_TYPE>' | '<STAGE>' | '<CHANGE_TYPES>', required — The URL parameter used to filter the webhook, including the brackets.
      - `values` string[], required — The list of values; if the URL parameter matches any value in the array, the webhook will be triggered.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/aurorasolar/apis/sync-api.md) · [All operations](https://skmtc.net/aurorasolar/apis/sync-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aurorasolar/sync-api/revisions/5b41808d104d/schema)