▣ DEVELOPER TOOLS · STANDARD DATA

Generate iCal API

Hosted on ApyHub

What it does

Calendar Event Generator creates iCal files from event details you send in JSON. You can generate a downloadable .ics file or a pre-signed cloud link to the generated file.

Send the event fields supported by the API: summary, meeting_date, start_time, end_time, location, description, time_zone, organizer_email, attendees_emails, reminders, recurrence, all_day, recurring, sequence, and id. For cancellation flows, set event_type to cancel on the download endpoint to produce a VCALENDAR with METHOD:CANCEL.

Use it when your app needs to hand off calendar invites after booking meetings, scheduling demos, or creating team reminders. It supports all-day events, recurring events, reminder rules, and time zone-aware scheduling, so you can generate invites that fit common calendar clients without building iCal serialization yourself.

If you need the file immediately, use the download endpoint. If you want a hosted asset instead, use the link endpoint and return the signed .ics URL in your workflow.

▣ ENDPOINT 01 / 02

POST

Generate iCal event — download file

http://localhost:8080/apyhub/generate-ical-event/download

QUICKSTARTGUIDE

Quickstart

Generate a downloadable iCal event file from the event details in the request body.

curl -X POST "http://localhost:8080/apyhub/generate-ical-event/download?output=my-invite" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "summary": "Team Sync",
  "description": "Weekly team sync to discuss project updates and action items.",
  "meeting_date": "2025-06-15",
  "start_time": "09:00",
  "end_time": "10:00",
  "location": "Conference Room A",
  "time_zone": "Europe/London",
  "organizer_email": "[email protected]",
  "attendees_emails": [
    "[email protected]",
    "[email protected]"
  ]
}'

What you'll get back

Returns a binary file, which is the generated iCal download.

my-invite.ics

TRY ITLIVE · 50 ATOMS

Loading playground…

About this endpoint

What it does

Generates an iCal event file for the provided event details and returns it as a binary download.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Override the default download filename, without extension.
event_type	ENUM	No	Use `cancel` to generate a VCALENDAR with `METHOD:CANCEL`. Allowed values: `cancel`.

Request Body

Parameter	Type	Mandatory	Description
id	String	No	Event UID. Auto-generated if omitted.
all_day	Boolean	No	Generate an all-day event. Default: `false`.
summary	String	No	Event title.
end_time	String	No	Time in `HH:MM` format. Ignored when `all_day` is true.
location	String	No	Event location.
sequence	Integer	No	iCal `SEQUENCE` number. Default: `0`.
recurring	Boolean	No	Whether the event recurs. Default: `false`.
reminders	Object Array	No	List of reminder objects. Each item requires `minutes_before`; see `reminders[].action`, `reminders[].description`, `reminders[].minutes_before`.
reminders[].action	ENUM	No	Reminder type. Allowed values: `display`, `email`. Default: `display`.
reminders[].description	String	No	Reminder message. Default: `Reminder`.
reminders[].minutes_before	Integer	Yes	Minutes before event start the reminder fires.
time_zone	String	No	IANA timezone identifier.
recurrence	Object	No	Recurrence settings. See `recurrence.count`, `recurrence.interval`, `recurrence.frequency`.
recurrence.count	Integer	No	Number of occurrences.
recurrence.interval	Integer	No	How often the recurrence rule repeats.
recurrence.frequency	String	No	iCal `FREQ` value, for example `DAILY`, `WEEKLY`, `MONTHLY`, or `YEARLY`.
start_time	String	No	Time in `HH:MM` format. Ignored when `all_day` is true.
description	String	No	Event description.
meeting_date	String	No	Date in `DD-MM-YYYY` or `YYYY-MM-DD` format.
organizer_email	String	No	Organizer email address.
attendees_emails	String Array	No	List of attendee email addresses.

Response

Returns a binary file response containing the generated iCal content. The output schema is a binary string, so there is no JSON object wrapper or top-level JSON fields to document.

Notes

start_time and end_time are ignored when all_day is true. The reminders array items must include minutes_before, and recurrence supports only the one-level nested fields shown in the schema.

Query parameters

Name

Type

Description

outputOPTIONAL

string

Override the default download filename (without extension).

event_typeOPTIONAL

string

cancel

Use 'cancel' to generate a VCALENDAR METHOD:CANCEL.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 02 / 02

POST

Generate iCal event — return cloud link

http://localhost:8080/apyhub/generate-ical-event/link

QUICKSTARTGUIDE

Quickstart

Generate a downloadable iCal file for a meeting by sending the event details in JSON.

curl -X POST "http://localhost:8080/apyhub/generate-ical-event/link" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "summary": "Team Sync",
  "description": "Weekly team sync to discuss project updates and action items.",
  "meeting_date": "2025-06-15",
  "start_time": "09:00",
  "end_time": "10:00",
  "location": "Conference Room A",
  "time_zone": "Europe/London",
  "organizer_email": "[email protected]",
  "attendees_emails": [
    "[email protected]",
    "[email protected]"
  ]
}'

What you'll get back

Returns a JSON object with a data string field containing a pre-signed URL to the generated .ics file.

{
  "data": "https://storage.example.com/invite_2025-06-15_abc123.ics?sig=abc123"
}

TRY ITLIVE · 50 ATOMS

Loading playground…

About this endpoint

What it does

Generates an iCal event file and returns a signed cloud URL to download the resulting .ics file. The request body contains the event details, and the response returns a JSON object with a data URI for the generated file.

Query Parameter(s)

Attribute	Type	Mandatory	Description
output	String	No	Override the default download filename without the extension.
event_type	ENUM	No	Allowed value: `cancel`.<br>Use `cancel` to generate a VCALENDAR `METHOD:CANCEL`.

Request Body

Parameter	Type	Mandatory	Description
id	String	No	Event UID. Auto-generated if omitted.
all_day	Boolean	No	Generate an all-day event. Default: `false`.
summary	String	No	Event title.
end_time	String	No	Time in `HH:MM` format. Ignored when `all_day` is `true`.
location	String	No	Event location.
sequence	Integer	No	iCal `SEQUENCE` number. Default: `0`.
recurring	Boolean	No	Whether the event recurs. Default: `false`.
reminders	Object Array	No	List of reminder objects. Each item has `action`, `description`, and required `minutes_before`.
reminders[].action	ENUM	No	Allowed values: `display`, `email`.<br>Reminder type. Default: `display`.
reminders[].description	String	No	Reminder message. Default: `Reminder`.
reminders[].minutes_before	Integer	Yes	Minutes before event start the reminder fires.
time_zone	String	No	IANA timezone identifier.
recurrence	Object	No	Recurrence settings for the event.
recurrence.count	Integer	No	Number of occurrences.
recurrence.interval	Integer	No	How often the recurrence rule repeats.
recurrence.frequency	String	No	iCal `FREQ` value such as `DAILY`, `WEEKLY`, `MONTHLY`, or `YEARLY`.
start_time	String	No	Time in `HH:MM` format. Ignored when `all_day` is `true`.
description	String	No	Event description.
meeting_date	String	No	Date in `DD-MM-YYYY` or `YYYY-MM-DD` format.
organizer_email	String	No	Organizer email address.
attendees_emails	String Array	No	List of attendee email addresses.

Response

Returns a JSON object with a required data string field formatted as a URI. The data value is a pre-signed URL for the generated .ics file.

Attribute	Type	Mandatory	Description
data	String	Yes	Pre-signed URL for the generated `.ics` file.

Query parameters

Name

Type

Description

outputOPTIONAL

string

Override the default download filename (without extension).

event_typeOPTIONAL

string

cancel

Use 'cancel' to generate a VCALENDAR METHOD:CANCEL.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.