---
title: "Create subscription"
method: POST
path: "/subscribe"
---

# Create subscription

`POST /subscribe`

## Request

- Base URL: `https://api.breezeway.io/public/webhook/v1`
- URL: `https://api.breezeway.io/public/webhook/v1/subscribe`
- Auth: API key in header `Authorization`

URL validation enforced. URLs must be valid and able to return a success status code.

## Request body

- object
  - `url` string, required: URL to receive POST request
  - `webhook_type` 'property-status' | 'task', required
  - `company_id` integer: Required if using cross-company access

## Response `200`

200

- object
  - `message` string
  - `id` integer
  - `company_id` integer
  - `url` string
  - `webhook_type` string

## Other responses

- `422`: 422

---

[API](https://skmtc.dev/breezeway/apis/breezeway-webhook-api.md) - [All operations](https://skmtc.dev/breezeway/apis/breezeway-webhook-api/llms.txt) - [OpenAPI document](https://skmtc.dev/breezeway/apis/breezeway-webhook-api/revisions/73b4e2c09cd4?raw)