v1

latestOpenAPI 3.0.02026-07-241010520.6 KB

Webhooks

Create Webhook

Create a new webhook.

post/tenants/{tenant_id}/webhooks

Path parameters

tenant_idstring uuid required

The ID of the tenant to create the webhook for.

Request body

Example request

{
  "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>",
    "description": "Aurora - AutoDesigner Webhook",
    "filters": [
      {
        "url_parameter": "<STATUS>",
        "values": [
          "submitted",
          "completed"
        ]
      }
    ]
  }
}

Response

Webhook successfully created.

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"
        ]
      }
    ]
  }
}