# Create a Webhook

Create a webhook subscription for the authenticated practice group. Hero will send an HTTP POST request to the specified URL whenever the subscribed event occurs.
**Available events:** `appointment.confirmed`, `appointment.cancelled`, `appointment.rescheduled`, `prescription.issued`, `patient.added-to-sequence`, `write-to-record.succeeded`, `write-to-record.failed`.
Optionally provide a `signing_key` to enable HMAC-SHA256 signature verification on incoming webhook requests. See the webhook security documentation for verification examples.

Endpoint: POST /v1/webhooks
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `practiceGroupId` (unknown)
    apiKey in header x-practice-group-id

## Request fields (application/json):

  - `description` (string)

  - `event_type` (string, required)
    Enum: "appointment.confirmed", "appointment.cancelled", "appointment.rescheduled", "form-submission.created", "prescription.issued", "patient.medical-record-updated", "patient.added-to-sequence", "write-to-record.succeeded", "write-to-record.failed"

  - `signing_key` (string)

  - `url` (string, required)

  - `headers` (object)

## Response 200:

  - `200` (unknown)
    Ok

## Response 200 fields (application/json):

  - `id` (string, required)

  - `event_type` (string, required)

  - `url` (string, required)

  - `signing_key` (string)

  - `headers` (object)

  - `created_at` (string, required)

  - `updated_at` (string, required)

## Response 400:

  - `400` (unknown)
    Validation error

## Response 400 fields (application/json):

  - `error` (boolean, required)
    Example: true

  - `statusCode` (number, required)
    Example: 400

  - `message` (array, required)

  - `message.code` (string, required)
    Example: invalid_type

  - `message.expected` (string, required)
    Example: string

  - `message.path` (array, required)
    Example: ["patient_id"]

  - `message.message` (string, required)
    Example: Required

## Response 401:

  - `401` (unknown)
    Unauthorised

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 500:

  - `500` (unknown)
    Unknown error

