JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.calendarConnection.createTarget('connectionId', {
  calendarId: 'clinic@example.com',
  durationMinutes: 30,
  name: 'Front desk',
});

console.log(response.data);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.calendar_connection.create_target(
    connection_id="connectionId",
    calendar_id="clinic@example.com",
    duration_minutes=30,
    name="Front desk",
)
print(response.data)

curl --request POST \
  --url https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Front desk",
  "calendarId": "clinic@example.com",
  "durationMinutes": 30,
  "bufferBeforeMinutes": 720,
  "bufferAfterMinutes": 720,
  "minNoticeMinutes": 262800,
  "horizonDays": 123,
  "slotIntervalMinutes": 123,
  "allDayEventsBlock": true,
  "hours": [
    {
      "weekday": 4,
      "startMinute": 719,
      "endMinute": 720
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Front desk',
    'calendarId' => 'clinic@example.com',
    'durationMinutes' => 30,
    'bufferBeforeMinutes' => 720,
    'bufferAfterMinutes' => 720,
    'minNoticeMinutes' => 262800,
    'horizonDays' => 123,
    'slotIntervalMinutes' => 123,
    'allDayEventsBlock' => true,
    'hours' => [
        [
                'weekday' => 4,
                'startMinute' => 719,
                'endMinute' => 720
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets"

	payload := strings.NewReader("{\n  \"name\": \"Front desk\",\n  \"calendarId\": \"clinic@example.com\",\n  \"durationMinutes\": 30,\n  \"bufferBeforeMinutes\": 720,\n  \"bufferAfterMinutes\": 720,\n  \"minNoticeMinutes\": 262800,\n  \"horizonDays\": 123,\n  \"slotIntervalMinutes\": 123,\n  \"allDayEventsBlock\": true,\n  \"hours\": [\n    {\n      \"weekday\": 4,\n      \"startMinute\": 719,\n      \"endMinute\": 720\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Front desk\",\n  \"calendarId\": \"clinic@example.com\",\n  \"durationMinutes\": 30,\n  \"bufferBeforeMinutes\": 720,\n  \"bufferAfterMinutes\": 720,\n  \"minNoticeMinutes\": 262800,\n  \"horizonDays\": 123,\n  \"slotIntervalMinutes\": 123,\n  \"allDayEventsBlock\": true,\n  \"hours\": [\n    {\n      \"weekday\": 4,\n      \"startMinute\": 719,\n      \"endMinute\": 720\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Front desk\",\n  \"calendarId\": \"clinic@example.com\",\n  \"durationMinutes\": 30,\n  \"bufferBeforeMinutes\": 720,\n  \"bufferAfterMinutes\": 720,\n  \"minNoticeMinutes\": 262800,\n  \"horizonDays\": 123,\n  \"slotIntervalMinutes\": 123,\n  \"allDayEventsBlock\": true,\n  \"hours\": [\n    {\n      \"weekday\": 4,\n      \"startMinute\": 719,\n      \"endMinute\": 720\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "label": "<string>",
    "durationMinutes": 123,
    "durationOptions": [
      123
    ],
    "requiresConfirmation": true,
    "isHidden": true,
    "policy": {
      "durationMinutes": 123,
      "bufferBeforeMinutes": 123,
      "bufferAfterMinutes": 123,
      "minNoticeMinutes": 123,
      "horizonDays": 123,
      "slotIntervalMinutes": 123,
      "allDayEventsBlock": true,
      "hours": [
        {
          "weekday": 4,
          "startMinute": 719,
          "endMinute": 720
        }
      ]
    },
    "target": {
      "provider": "CAL_COM",
      "eventTypeId": 123
    }
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "conflict",
  "code": "resource_in_use",
  "message": "The resource is in use and cannot be deleted"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

Calendar Integration

Create a bookable target

Only for a connection whose capabilities.roarkOwnsBookingPolicy is true. A calendar with no scheduling of its own has nothing an agent can be pointed at, so the thing a calendar tool books into is created here: the calendar, how long an appointment runs, and the hours it is offered in. The policy and the hours are written together, because a target with no hours offers nothing. Refused if the calendar is one the account can only read.

POST

integrations

calendar

{connectionId}

targets

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.calendarConnection.createTarget('connectionId', {
  calendarId: 'clinic@example.com',
  durationMinutes: 30,
  name: 'Front desk',
});

console.log(response.data);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.calendar_connection.create_target(
    connection_id="connectionId",
    calendar_id="clinic@example.com",
    duration_minutes=30,
    name="Front desk",
)
print(response.data)

curl --request POST \
  --url https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Front desk",
  "calendarId": "clinic@example.com",
  "durationMinutes": 30,
  "bufferBeforeMinutes": 720,
  "bufferAfterMinutes": 720,
  "minNoticeMinutes": 262800,
  "horizonDays": 123,
  "slotIntervalMinutes": 123,
  "allDayEventsBlock": true,
  "hours": [
    {
      "weekday": 4,
      "startMinute": 719,
      "endMinute": 720
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Front desk',
    'calendarId' => 'clinic@example.com',
    'durationMinutes' => 30,
    'bufferBeforeMinutes' => 720,
    'bufferAfterMinutes' => 720,
    'minNoticeMinutes' => 262800,
    'horizonDays' => 123,
    'slotIntervalMinutes' => 123,
    'allDayEventsBlock' => true,
    'hours' => [
        [
                'weekday' => 4,
                'startMinute' => 719,
                'endMinute' => 720
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets"

	payload := strings.NewReader("{\n  \"name\": \"Front desk\",\n  \"calendarId\": \"clinic@example.com\",\n  \"durationMinutes\": 30,\n  \"bufferBeforeMinutes\": 720,\n  \"bufferAfterMinutes\": 720,\n  \"minNoticeMinutes\": 262800,\n  \"horizonDays\": 123,\n  \"slotIntervalMinutes\": 123,\n  \"allDayEventsBlock\": true,\n  \"hours\": [\n    {\n      \"weekday\": 4,\n      \"startMinute\": 719,\n      \"endMinute\": 720\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Front desk\",\n  \"calendarId\": \"clinic@example.com\",\n  \"durationMinutes\": 30,\n  \"bufferBeforeMinutes\": 720,\n  \"bufferAfterMinutes\": 720,\n  \"minNoticeMinutes\": 262800,\n  \"horizonDays\": 123,\n  \"slotIntervalMinutes\": 123,\n  \"allDayEventsBlock\": true,\n  \"hours\": [\n    {\n      \"weekday\": 4,\n      \"startMinute\": 719,\n      \"endMinute\": 720\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/integrations/calendar/{connectionId}/targets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Front desk\",\n  \"calendarId\": \"clinic@example.com\",\n  \"durationMinutes\": 30,\n  \"bufferBeforeMinutes\": 720,\n  \"bufferAfterMinutes\": 720,\n  \"minNoticeMinutes\": 262800,\n  \"horizonDays\": 123,\n  \"slotIntervalMinutes\": 123,\n  \"allDayEventsBlock\": true,\n  \"hours\": [\n    {\n      \"weekday\": 4,\n      \"startMinute\": 719,\n      \"endMinute\": 720\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "label": "<string>",
    "durationMinutes": 123,
    "durationOptions": [
      123
    ],
    "requiresConfirmation": true,
    "isHidden": true,
    "policy": {
      "durationMinutes": 123,
      "bufferBeforeMinutes": 123,
      "bufferAfterMinutes": 123,
      "minNoticeMinutes": 123,
      "horizonDays": 123,
      "slotIntervalMinutes": 123,
      "allDayEventsBlock": true,
      "hours": [
        {
          "weekday": 4,
          "startMinute": 719,
          "endMinute": 720
        }
      ]
    },
    "target": {
      "provider": "CAL_COM",
      "eventTypeId": 123
    }
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "conflict",
  "code": "resource_in_use",
  "message": "The resource is in use and cannot be deleted"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionId

string

required

Calendar connection ID

Body

application/json

A bookable target to create on a connection whose provider has no scheduling of its own.

name

string

required

Unique within the connection, and how a config file refers to this target. Letters, digits, spaces, _ or -.

Required string length: 1 - 120

Example:

"Front desk"

calendarId

string

required

The calendar to write appointments to, from GET /v1/integrations/calendar/{connectionId}/calendars. primary is accepted and stored as the account’s own id.

Minimum string length: 1

Example:

"clinic@example.com"

durationMinutes

integer

required

Required range: x <= 1440

Example:

30

bufferBeforeMinutes

integer | null

Dead time before an appointment, counted as busy when a slot is offered. Defaults to 0.

Required range: 0 <= x <= 1440

bufferAfterMinutes

integer | null

Required range: 0 <= x <= 1440

minNoticeMinutes

integer | null

How soon from now an appointment may be made. Defaults to 120.

Required range: 0 <= x <= 525600

horizonDays

integer | null

How far ahead appointments may be made. Defaults to 30.

Required range: x <= 365

slotIntervalMinutes

integer | null

The grid slots are offered on. Defaults to the duration, which gives back-to-back appointments.

Required range: x <= 1440

allDayEventsBlock

boolean | null

Whether an all-day event closes the day. Defaults to true, because a calendar marks all-day events free unless their creator says otherwise and a public holiday entered as one would otherwise be bookable.

hours

BookableHours · object[] | null

The windows of the week appointments are offered in. Omit to adopt Monday to Friday, 09:00 to 17:00. A target with no windows offers nothing at all, which reads to a caller as a permanently full diary.

Required array length: 1 - 42 elements

Show child attributes

Response

The target, in the same shape GET /targets lists.

data

BookableTarget · object

required

Something on a connected account an agent can be pointed at: a Cal.com event type, or a bookable target on a calendar whose booking policy Roark owns.

Show child attributes