README.md

calendly-python 🐍

Python package to use the Calendly API 🚀

Installation

pip install calendly

Usage

Set your Authentication token

See Calendly docs to get your auth token

from calendly import Calendly
calendly = Calendly(api_key)

Test the auth token

calendly.echo()

Get list of events

calendly.events()

Webhooks

Create A Webhook Subscription

calendly.create_webhook('https://your-webhook.com', events=['canceled', 'invited'])

• Note: the events variable is a list
• Note: possible values are: canceled and invited
• Note: by default the events list contains the 2 possible values

Get Webhook Subscription

calendly.get_webhook('webhook_id')

Get List of Webhook Subscriptions

calendly.list_webhooks()

Delete Webhook Subscription

calendly.remove_webhook('webhook_id')

• Note: the response will be {'success': True} if the webhook was successfully removed, otherwise it will be {'success': False, "type": "calendly type", "message": "reason it failed"}

User Event Types

calendly.event_types()

About Me

calendly.about()

Important

• Note: All the responses are dictionaries with the calendly response, except for the remove webhook method that also contains the success key. Check their docs to know the possible responses!

TODOs:

Next steps for this package:

• Improve how the methods return the responses: proccess Calendly responses and make them objects, so that users can manage the information in an easier way
• Support for version 2 <3
• Creating reusable exceptions for error messages