---
title: "Calendar designation created"
method: POST
path: "calendar_designation.created"
tags: ["webhooks"]
---

# Calendar designation created

`POST calendar_designation.created` (webhook)

Triggered when a new calendar designation is created.

## Payload

- CalendarDesignationCreatedWebhookPayload
  - `data` object, required
    - `appointment_kind_ids` integer[]: The IDs of the appointment kinds this designation is reserved for.
    - `calendar.clinic_id` integer, required: The ID of the clinic this designation belongs to.
    - `created` string, date-time, required: The datetime this object was created.
    - `deleted` string, date-time, nullable, required: The datetime this record was soft deleted.
    - `duration_minutes` integer, required: Duration of the designation in minutes.
    - `end_datetime` string, date-time, required: ISO 8601 formatted end datetime of the designation in UTC.
    - `id` integer, required: The unique identifier for this calendar designation.
    - `is_deleted` boolean, required: Whether this record is soft deleted or not.
    - `is_recurring` boolean, required: Whether this record follows a recurrence pattern.
    - `modified` string, date-time, required: The datetime this object was last modified; changes to related entities will not update this field.
    - `name` string, required: Display name for this designation.
    - `recurrence` RecurrenceBreakdownSchema: Structured representation of an RFC 2445 recurrence rule.
      - `days_of_week` string[]: Two-letter day codes. Applicable for WEEKLY and some MONTHLY patterns.
      - `end_after_occurrences` integer, nullable: Total number of occurrences before the recurrence ends, if bounded by count.
      - `end_date` string, date, nullable: ISO 8601 date (YYYY-MM-DD) when the recurrence ends, if bounded by date.
      - `frequency` 'YEARLY' | 'MONTHLY' | 'WEEKLY' | 'DAILY' | 'HOURLY' | 'MINUTELY' | 'SECONDLY', required: The base recurring frequency.
      - `interval` integer, required: The interval between each frequency iteration (e.g., 2 means every 2 weeks for WEEKLY).
    - `recurrence_excluded_datetimes` string[]: Specific datetimes excluded from the recurrence pattern.
    - `recurring_designation_id` integer, nullable: If this is an exception to a recurring designation, the ID of the parent.
    - `resource_id` integer, required: The ID of the calendar resource this designation is assigned to.
    - `rrule` string, nullable: Raw RFC 2445 RRule string, if recurring.
    - `start_datetime` string, date-time, required: ISO 8601 formatted start datetime of the designation in UTC.
  - `type` 'calendar_designation.created', required: The event type identifier.

## Acknowledgement `200`

Webhook received

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)