Webhook event

`quote.created`

A Quote was created.

Payload schema

api_versionanyrequired
contextobject
Present only when source is api. Identifies the acting project and API key.
- developer_platform_api_key_idstring | null · uuid
- developer_platform_project_idstring | null · uuid
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
dataobjectrequired
- objectobjectrequired
  - accepted_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - alternative_payor_idstring | null · uuidrequired
    The AlternativePayor for an alternative-payor Quote.
  - booking_idsarrayrequired
    The Bookings linked to the Quote.
    - itemsstring · uuid
  - cancel_reasonstring | nullrequired
    Why the Quote was canceled. staff is a staff cancellation. superseded is set when a revised Quote replaces it.
    Allowed values: staff | superseded | null
  - canceled_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - clinician_idstring | null · uuidrequired
    The Clinician attributed to the Quote.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - creation_sourcestring | nullrequired
    How the Quote was created.
    Allowed values: staff_member | api | null
  - currencystring | nullrequired
    The ISO 4217 currency code.
  - current_invoice_idstring | null · uuidrequired
    The current non-cancelled Invoice generated from the Quote.
  - declined_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - expired_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - expires_onstring | null · daterequired
    The date the Quote remains valid through.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - invoice_idstring | null · uuidrequired
    The Invoice created by the first conversion or acceptance.
  - invoice_idsarrayrequired
    Every Invoice generated from the Quote, including cancelled generations.
    - itemsstring · uuid
  - invoiced_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - line_itemsarrayrequired
    The proposed charges on the Quote.
    - itemsobject
      - booking_idstring | null · uuidrequired
        The Booking associated with the line item.
      - created_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
      - currencystring | nullrequired
        The ISO 4217 currency code.
      - discount_amountinteger | nullrequired
        The discount in minor currency units.
      - external_provider_namestring | nullrequired
        The provider that collects an external fee.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - is_billed_by_another_providerbooleanrequired
        Whether another provider bills this line instead of the practice that issued the Quote.
      - objectanyrequired
        Discriminator value emitted at object.
      - quantitynumber | nullrequired
        The quantity quoted.
      - titlestring | nullrequired
        The line item description.
      - totalinteger | nullrequired
        The line total in minor currency units.
      - unit_priceinteger | nullrequired
        The unit price in minor currency units.
      - updated_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - linksobjectrequired
    URLs to related resources.
    - alternative_payorstring | null · urirequired
      The full URL of a related resource.
    - bookingsarrayrequired
      Developer Platform URLs for linked Bookings.
      - itemsstring · uri
        The full URL of a related resource.
    - clinicianstring | null · urirequired
      The full URL of a related resource.
    - current_invoicestring | null · urirequired
      The full URL of a related resource.
    - invoicestring | null · urirequired
      The full URL of a related resource.
    - invoicesarrayrequired
      Developer Platform URLs for every generated Invoice.
      - itemsstring · uri
        The full URL of a related resource.
    - patientstring | null · urirequired
      The full URL of a related resource.
  - notesstring | nullrequired
    Sanitized HTML notes on the Quote.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring | null · uuidrequired
    The Patient associated with the Quote.
  - payor_typestring | nullrequired
    The party the Quote is issued to.
    Allowed values: patient | alternative_payor | null
  - quote_numberstring | nullrequired
    The Quote number, unique within the Organization.
  - quoted_onstring | null · daterequired
    The date the Quote was issued or drafted.
  - recipient_display_namestring | nullrequired
    The display name of the live Patient or AlternativePayor the Quote is sent to.
  - sent_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - statusstring | nullrequired
    The Quote's current status.
    Allowed values: draft | sent | accepted | declined | expired | canceled | invoiced | null
  - termsstring | nullrequired
    Sanitized HTML terms copied onto the Quote.
  - titlestring | nullrequired
    The Quote title.
  - totalintegerrequired
    The Quote total in minor currency units, including lines billed by another provider.
  - total_collectible_by_issuing_organizationintegerrequired
    The amount the issuing Organization will collect, in minor currency units. Excludes lines billed by another provider.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
developer_platform_project_idstring | null · uuidrequired
The project ID whose credential caused the change. Null for dashboard events.
idstringrequired
Event identifier prefixed with evt_.
livemodebooleanrequired
false for test-event deliveries.
objectanyrequired
sourcestringrequired
Origin of the change. api means a Developer Platform mutation; dashboard means a Carebit-initiated change.
Allowed values: api | dashboard
typeanyrequired

Example

{
  "id": "evt_00000000-0000-4000-8000-000000000012",
  "object": "event",
  "api_version": "v1",
  "created_at": "2026-01-01T09:00:00Z",
  "data":  … }
    "object":  … }
      "id": "00000000-0000-4000-8000-000000000029",
      "object": "quote",
      "accepted_at": null,
      "alternative_payor_id": null,
      "booking_ids":  … ]
        "00000000-0000-4000-8000-000000000001"
      ],
      "cancel_reason": null,
      "canceled_at": null,
      "clinician_id": "00000000-0000-4000-8000-000000000002",
      "created_at": "2026-01-01T09:00:00Z",
      "creation_source": "api",
      "currency": "gbp",
      "current_invoice_id": null,
      "declined_at": null,
      "expired_at": null,
      "expires_on": "2026-01-31",
      "invoice_id": null,
      "invoice_ids": [],
      "invoiced_at": null,
      "line_items":  … ]
         … }
          "id": "00000000-0000-4000-8000-000000000030",
          "object": "quote_line_item",
          "booking_id": "00000000-0000-4000-8000-000000000001",
          "created_at": "2026-01-01T09:00:00Z",
          "currency": "gbp",
          "discount_amount": 0,
          "external_provider_name": null,
          "is_billed_by_another_provider": false,
          "quantity": 1,
          "title": "Initial consultation",
          "total": 25000,
          "unit_price": 25000,
          "updated_at": "2026-01-01T09:00:00Z"
        }
      ],
      "links":  … }
        "alternative_payor": null,
        "bookings":  … ]
          "https://api.carebit.co/v1/bookings/00000000-0000-4000-8000-000000000001"
        ],
        "clinician": "https://api.carebit.co/v1/clinicians/00000000-0000-4000-8000-000000000002",
        "current_invoice": null,
        "invoice": null,
        "invoices": [],
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "notes": "",
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "payor_type": "patient",
      "quote_number": "QUO-1001",
      "quoted_on": "2026-01-01",
      "recipient_display_name": "Test Patient",
      "sent_at": null,
      "status": "draft",
      "terms": "<p>This quote is valid until the expiry date shown.</p>",
      "title": "Initial consultation quote",
      "total": 25000,
      "total_collectible_by_issuing_organization": 25000,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "quote.created"
}

Prefer plain text? Append ?format=md or send Accept: text/markdown to receive this page as raw Markdown.