SavvyCal API
Endpoints
Resources
Webhooks
SavvyCal API
Home

Event

A representation of an event scheduled via SavvyCal.

Properties

This resource includes the following properties:

Property Type Description
id string The event ID.
state string The event state (either confirmed or canceled).
summary string The summary (title) of the event.
description string The description of the event.
location string The location of the event.
created_at string The ISO-8601 timestamp when the event was created.
start_at string The ISO-8601 timestamp when the event starts.
end_at string The ISO-8601 timestamp when the event end.
canceled_at string | null The ISO-8601 timestamp when the event was canceled.
cancel_reason string | null The reason the event was canceled.
rescheduled_at string | null The ISO-8601 timestamp when the event was rescheduled.
reschedule_reason string | null The reason the event was rescheduled.
original_start_at string The ISO-8601 timestamp when the event originally started.
original_end_at string The ISO-8601 timestamp when the event originally ended.
conferencing Event Conferencing An object containing conferencing info.
link Scheduling Link Preview The scheduling link used to book the event.
scope Scope Preview The scope of the scheduling link.
scheduler Event Attendee The scheduler of the event.
organizer Event Attendee The organizer of the event.
attendees array of Event Attendee A list of all event attendees (including the scheduler and organizer).
metadata object An object containing custom metadata attached to the event.
url string The URL of the SavvyCal event.

Example

Here is an example representation of this resource:

{
"id": "event_XXXXXXXXXX",
"state": "confirmed",
"summary": "Joe Organizer and Sally Scheduler",
"description": "Let's find a time to chat!",
"location": "https://us2.zoom.us/XXXXXXXX",
"conferencing": {
"type": "zoom",
"meeting_id": "XXXXXXXX",
"join_url": "https://us2.zoom.us/XXXXXXXX",
"instructions": "Joe Organizer is inviting you to a meeting..."
},
"created_at": "2020-01-01T00:00:00Z",
"start_at": "2020-01-01T00:00:00Z",
"end_at": "2020-01-01T00:30:00Z",
"canceled_at": null,
"cancel_reason": null,
"rescheduled_at": null,
"reschedule_reason": null,
"original_start_at": null,
"original_end_at": null,
"link": {
"id": "link_XXXXXXXXXX",
"name": "Quick Chat",
"private_name": "VIP Chat",
"slug": "chat"
},
"scope": {
"id": "scope_XXXXXXXXXX",
"name": "Joe Organizer",
"slug": "joe"
},
"scheduler": {
"id": "attendee_XXXXXXXXXX",
"email": "sally@example.com",
"display_name": "Sally Scheduler",
"time_zone": "America/Chicago",
"response_status": "confirmed",
"is_organizer": false,
"is_scheduler": true,
"fields": [{
"id": "field_XXXXX",
"type": "text",
"label": "What are we discussing today?",
"value": "The price of Bitcoin"
}]
},
"organizer": {
"id": "attendee_XXXXXXXXXX",
"email": "joe@example.com",
"display_name": "Joe Organizer",
"first_name": "Joe",
"last_name": "Organizer",
"phone_number": null,
"time_zone": "America/Chicago",
"response_status": "confirmed",
"is_organizer": true,
"is_scheduler": false,
"fields": []
},
"attendees": [
{
"id": "attendee_XXXXXXXXXX",
"email": "sally@example.com",
"display_name": "Sally Scheduler",
"first_name": "Sally",
"last_name": "Scheduler",
"phone_number": null,
"time_zone": "America/Chicago",
"response_status": "confirmed",
"is_organizer": false,
"is_scheduler": true,
"fields": [{
"id": "field_XXXXX",
"type": "text",
"label": "What are we discussing today?",
"value": "The price of Bitcoin"
}]
},
{
"id": "attendee_XXXXXXXXXX",
"email": "joe@example.com",
"display_name": "Joe Organizer",
"first_name": "Joe",
"last_name": "Organizer",
"phone_number": null,
"time_zone": "America/Chicago",
"response_status": "confirmed",
"is_organizer": true,
"is_scheduler": false,
"fields": []
}
],
"metadata": {
"user_id": 123
},
"url": "https://savvycal.com/events/XXXXXXXX"
}