get_subscribe_links

This reference is generated from the published tool contract.

Behavior and boundaries

Returns the links people use to subscribe: the webcal address for any calendar app and direct links for Google Calendar, Outlook.com, Microsoft 365 and Apple Calendar. Share them on a website, in a newsletter or a message.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

public_calendars:read

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "calendar_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Calendar id from list_public_calendars."
    }
  },
  "required": [
    "calendar_id"
  ],
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "webcal": {
      "type": "string"
    },
    "feed_url": {
      "type": "string"
    },
    "subscribe_links": {
      "type": "object",
      "properties": {
        "google": {
          "type": "string"
        },
        "outlook": {
          "type": "string"
        },
        "office365": {
          "type": "string"
        },
        "apple": {
          "type": "string"
        }
      },
      "required": [
        "google",
        "outlook",
        "office365",
        "apple"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "webcal",
    "feed_url",
    "subscribe_links"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling