A few things we think you should know!
- 7 Topics
- 0 Replies
If you’re getting started with the Calendly API or advanced embed, the Developer Portal is the best place to start!Getting started - an overview of our APIs and the different ways you can authenticate. Create a developer account - instructions on making an account to create and manage OAuth credentials. API Reference - our up-to-date API reference, including a full list of available endpoints. API use cases and API recipes - some ideas and tutorials related to common API uses. Release notes - stay up to date with new releases and use our RSS or Atom subscription options.We also have some embed Help Center articles that are helpful to developers.Advanced embed - an outline of our advanced embed code, including a function to manually initialize an inline embed. Source tracking with your Calendly embed and UTM parameters - a great reference for passing UTM parameters to an embed.
When initializing a Calendly embed with widget.js, our script adds two parameters to the iframe embed’s URL. The presence of these two parameters will allow the booking page to ‘behave’ like an embed.The parameters that our script adds are embed_domain and embed_type.When the parameters are included, the booking page will:show a transparent background behind the booking container instead of a light background, allow the option to hide the cookie banner and cookie preferences, and send notifications to the parent window with window.postMessage().There are a few reasons that these parameters can be missing from your embed:When loading an HTML file in your browser directly from your computer’s local files, embed_domain will be missing. (Note: loading a localhost page will populate the domain parameter - only pages opened directly will be impacted.) Loading an embed in a WebView can also sometimes result in embed_domain being missing, so you may need to add this manually to the URL. If you
If you are not receiving webhook data, it is possible that your webhook has become disabled or is in the process of becoming disabled because Calendly cannot successfully send a POST request to your server.When you call the get webhook subscription endpoint, the state will indicate whether the webhook is active or disabled. If the webhook is in the disabled state, you will need to delete it and create a new webhook after resolving any server issues that would cause this (see further below for more details).You can also reference retry_started_at to see the last time Calendly needed to start retrying because the POST request was not successfully received by your server. How does a webhook become disabled?If the URL that you are using for your webhook subscription returns non-2xx responses or if the connection times out, the retry process will start. Calendly will continue to try to deliver the data for 24 hours with an exponential back-off that makes attempts less and less frequently. A
When calling Calendly API endpoints, you will sometimes be required to include a user and/or organization value. For example, the list events endpoint requires that you pass either a user or organization parameter depending on the scope you’d like to request and the create webhook subscription requires the organization and optionally the user to be passed in the body. But what are those values and how do you get them? The value you will need to pass is the user or organization URI.The easiest way to get these values is to call the get current user endpoint. The user URI can be found in uri and the organization URI can be found in current_organization.If you are using OAuth, these values will also be contained in the response when you get an access token. The user URI will be provided in owner and the organization URI will be in organization.Please note that you will need to pass the entire URI, not just the UUID portion. We recommend working with and saving entire URIs because UUIDs wi
An organization URI value is needed with a user-scoped webhook because a user can have multiple organizations associated with their data in Calendly, such as when they had their personal Calendly account before they were a member of an organization or after they leave an organization. As such, the organization is needed to confirm the specific user data that should be returned.
Yes, to cancel an event via the API, you can send a POST request to the cancel event endpoint.At this time, there is no API endpoint that supports rescheduling an event or invitee, however the cancel and reschedule URLs are on the invitee resource.However, the cancel and reschedule URLs can be found on the v2 API webhook payload as well. You can see an example of the payload here.These URLs are always inserted at the bottom of calendar events or email confirmations, but they are available on the API to be more easily retrievable so you can place them wherever you want in the app that you are building.Please note that cancel event endpoint can be used to cancel an event, including a Group event, but not an individual invitee in a Group event.
Already have an account? Login
Login to the community
Not a Calendly user yet? Head on over to Calendly.com to get started before logging into the community.Employee Login Customer Login
Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.