Webhook event

`expirable_file.available`

An ExpirableFile is available to download.

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
  - attachment_urlstring | null · urirequired
    The temporary signed download URL, or null while Carebit generates the file and download URL.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - expires_atstring · date-timerequired
    The time after which Carebit can delete the file.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - objectanyrequired
    Discriminator value emitted at object.
  - statusstringrequired
    Whether Carebit is still creating the report or the file is ready to download.
    Allowed values: processing | succeeded
  - titlestringrequired
    The report type used as the title of the ExpirableFile.
    Allowed values: account_balances | audio_recordings | billing_codes | booked_services | bookings | bookings_summary_for_child_organizations | bookings_with_invoices | bookings_without_invoices | care_episodes | cari_credits_usage | credit_notes | creditors | debtors | debtors_per_invoice | end_of_year_accounts_zip | expenses | financial_summary | indemnity_bookings | indemnity_income | invoice_line_items | issued_invoices | issued_invoices_summary_for_child_organizations | leads_and_enquiries | patient_referrals | patient_registrations | prescriptions_report | product_sales_audit_log | product_sales_report | product_stock_levels_report | profit_and_loss | recall_bookings | received_payments | received_payments_for_invoice_line_items | received_payments_summary_for_child_organizations | referral_summary | refunds | remittance_adjustments | service_variants | tasks_due_per_staff_member | tasks_raised
  - 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-000000000019",
      "object": "expirable_file",
      "attachment_url": "https://files.example.invalid/reports/bookings.csv?signature=test",
      "created_at": "2026-01-01T09:00:00Z",
      "expires_at": "2026-01-02T09:00:00Z",
      "status": "succeeded",
      "title": "bookings",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  },
  "developer_platform_project_id": null,
  "livemode": false,
  "source": "dashboard",
  "type": "expirable_file.available"
}

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