Calendly
Calendly is a scheduling platform used for teams to schedule, prepare and follow up on external meetings.
The Calendly Wrapper is a WebAssembly(Wasm) foreign data wrapper which allows you to read data from your Calendly for use within your Postgres database.
Warning
Restoring a logical backup of a database with a materialized view using a foreign table can fail. For this reason, either do not use foreign tables in materialized views or use them in databases with physical backups enabled.
Supported Data Types
Postgres Data Type | Calendly Data Type |
---|---|
boolean | Boolean |
bigint | Number |
double precision | Number |
text | String |
timestamp | Time |
timestamptz | Time |
jsonb | Json |
The Calendly API uses JSON formatted data, please refer to Calendly API docs for more details.
Available Versions
Version | Wasm Package URL | Checksum |
---|---|---|
0.1.0 | https://github.com/supabase/wrappers/releases/download/wasm_calendly_fdw_v0.1.0/calendly_fdw.wasm |
51a19fa4b8c40afb5dcf6dc2e009189aceeba65f30eec75d56a951d78fc8893f |
Preparation
Before you get started, make sure the wrappers
extension is installed on your database:
1 |
|
and then create the Wasm foreign data wrapper:
1 2 3 |
|
Secure your credentials (optional)
By default, Postgres stores FDW credentials inside pg_catalog.pg_foreign_server
in plain text. Anyone with access to this table will be able to view these credentials. Wrappers is designed to work with Vault, which provides an additional level of security for storing credentials. We recommend using Vault to store your credentials.
1 2 3 4 5 6 7 |
|
Connecting to Calendly
We need to provide Postgres with the credentials to access Calendly and any additional options. We can do this using the create server
command:
1 2 3 4 5 6 7 8 9 10 11 12 |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
Note the fdw_package_*
options are required, which specify the Wasm package metadata. You can get the available package version list from above.
Create a schema
We recommend creating a schema to hold all the foreign tables:
1 |
|
Creating Foreign Tables
The Calendly Wrapper supports data reads from below objects in calendly.
Integration | Select | Insert | Update | Delete | Truncate |
---|---|---|---|---|---|
Current User | ✅ | ❌ | ❌ | ❌ | ❌ |
Event Types | ✅ | ❌ | ❌ | ❌ | ❌ |
Groups | ✅ | ❌ | ❌ | ❌ | ❌ |
Organization Membership | ✅ | ❌ | ❌ | ❌ | ❌ |
Scheduled Events | ✅ | ❌ | ❌ | ❌ | ❌ |
For example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
|
Note
- All the supported columns are listed above, other columns are not allowd.
- The
attrs
is a special column which stores all the object attributes in JSON format, you can extract any attributes needed from it. See more examples below.
Foreign table options
The full list of foreign table options are below:
object
- Object name in Calendly, required.
Supported objects are listed below:
Object name |
---|
current_user |
event_types |
groups |
organization_memberships |
scheduled_events |
Query Pushdown Support
This FDW doesn't support query pushdown.
Examples
Below are some examples on how to use Calendly foreign tables.
Basic example
This example will create a "foreign table" inside your Postgres database and query its data. First, we can create a schema to hold all the Calendly foreign tables.
1 |
|
Then create the foreign table and query it, for example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
attrs
is a special column which stores all the object attributes in JSON format, you can extract any attributes needed from it. See more examples below.
Query JSON attributes
1 2 3 4 5 6 |
|
Some other examples,
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|