iCal Event Generator

iCal Event Generator

What it does

iCal Event Generator creates calendar invites as downloadable .ics files or as pre-signed cloud links. Send event details in the request body, and it returns a calendar file you can attach to email, store, or hand off to another system.

Use it to generate single events, all-day events, or recurring meetings. The input supports an event UID, summary, start and end time, meeting date, location, time zone, sequence number, organizer email, attendee email list, reminders, and recurrence settings such as frequency, interval, and count. If you omit the UID, one is generated for you. If you set all_day to true, the time fields are ignored.

The download endpoint returns the file directly, with optional query parameters to set the filename or generate a VCALENDAR METHOD:CANCEL for cancellations. The link endpoint returns a JSON object containing a signed URL in data, which is useful when you want to fetch the .ics file later without streaming it immediately.

This is a fit for booking flows, internal scheduling tools, calendar sync, and automated meeting workflows where you need a standards-based iCal file from structured event data.

curl -X POST "https://api.eu.apyverse.com/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]" ] }'

About this endpoint

What it does

Generates an iCal event file for download from the supplied event details. The request body defines the event content, and the endpoint returns a binary 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`. Use `cancel` to generate a VCALENDAR with `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	Reminder entries. Each item requires `minutes_before`.
reminders[].action	ENUM	No	Allowed values: `display`, `email`. 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.
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 binary file as the success response. The output schema is a binary string, so the response body is the downloadable iCal file rather than a JSON object.

curl -X POST "https://api.eu.apyverse.com/apyhub/generate-ical-event/link" \ -H "apy-token: $APY_TOKEN" \ -H "Content-Type: application/json" \ -d '{"summary":"Team Sync","meeting_date":"2025-06-15","start_time":"09:00","end_time":"10:00"}'

About this endpoint

What it does

Generates an iCal event file from the provided event details and returns a pre-signed cloud URL to the generated .ics file.

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 METHOD:CANCEL`. Allowed value: `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	Reminder entries. Each item requires `minutes_before`; see item fields below.
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.
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 data string field containing a URI — the pre-signed URL for the generated .ics file.

Parameter	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

—

What it does

QUICKSTART

Quickstart

What you'll get back

About this endpoint

What it does

Query Parameter(s)

Request Body

Response

Query parameters

Body

QUICKSTART

Quickstart

What you'll get back

About this endpoint

What it does

Query Parameter(s)

Request Body

Response

Query parameters

Body

Errors any endpoint can return