Quickstart guide

• Create an account
• Create an API token
• Perform an API request test

Convier is a REST API which allows users to exchange calendaring and scheduling information such as events, to-dos and journal entries directly in your users' calendars.

Using Convier is simple and only requires three steps:

1. Create an account and subscribe to a plan.
2. Create an API token.
3. Perform an API request test to make sure everything works.

Create an account

You can create a Convier account using the register link. Several plans are available depending on your needs:

{info} You can start for free. No credit card is required.

Create an API token

Convier authenticates your API requests using an API token from your account. Convier returns an error if you do not include a valid token in your requests.

{primary} Tokens are unlimited in time; you can create as many tokens as you want in the API Tokens section of your dashboard.

Perform an API request test

To verify that your setup is working properly, perform an API request test using an API token to create an Event request.

Replace your API token, and your email in this sample code.

curl https://convier.me/api/event \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-d 'event[start][date]=05/26/2019 08:00 PM' \
-d 'event[end][date]=05/26/2019 11:00 PM' \
-d 'event[organizer][name]=Tony Stark' \
-d 'event[organizer][email]=ironman@avengers.com' \
-d 'event[summary][text]=Endgame premiere' \
-d 'event[description][text]=Bring the popcorn.' \
-d 'event[attendees][0][email]=USER_EMAIL'

Convier returns the UID (Unique Identifier) of the calendar sent in response to your API request.

{
    "error": false, 
    "message": null, 
    "uid": 20201225T101441Z-5fe5bb91debc4,
    "data": null
}

You may save the UID if you plan to update your event later (feature available depending on your subscription plan).

That's it, you are ready to go!