AUaurorasolar
Webhooks

Retrieve Webhook

Changed on

Retrieve a webhook by ID

get/tenants/{tenant_id}/webhooks/{webhook_id}

Request

  • Base URL
    https://api-sandbox.aurorasolar.com
  • URL
    https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/webhooks/{webhook_id}
  • Auth
    HTTP bearer

Path parameters

tenant_idstring uuid required

The ID of the tenant to get webhooks for.

webhook_idstring uuid required

The ID of the webhook to return details for.

Response

Webhook successfully retrieved.

Example response

{
  "webhook": {
    "description": "Aurora - AutoDesigner Webhook",
    "event": "agreement_status_changed",
    "url_template": "https://www.webhookclient.com/auto_designer_job_completed?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>",
    "filters": [
      {
        "url_parameter": "<STATUS>",
        "values": [
          "submitted",
          "completed"
        ]
      }
    ]
  }
}

Changes

  • 97a7ad8a993aRevision changes
    • warning

      added the new <IS_FIRST_VIEW> enum value to the /// response property for the response status

    • warning

      added the new web_proposal_viewed enum value to the / response property for the response status