Skip to main content
PATCH
/
v2
/
webhooks
/
{webhookId}
Update a webhook
curl --request PATCH \
  --url https://api.cal.com/v2/webhooks/{webhookId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payloadTemplate": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}",
  "active": true,
  "subscriberUrl": "<string>",
  "triggers": [
    "BOOKING_CREATED",
    "BOOKING_RESCHEDULED",
    "BOOKING_CANCELLED",
    "BOOKING_CONFIRMED",
    "BOOKING_REJECTED",
    "BOOKING_COMPLETED",
    "BOOKING_NO_SHOW",
    "BOOKING_REOPENED"
  ],
  "secret": "<string>",
  "version": "2021-10-20"
}
'
import requests

url = "https://api.cal.com/v2/webhooks/{webhookId}"

payload = {
"payloadTemplate": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}",
"active": True,
"subscriberUrl": "<string>",
"triggers": ["BOOKING_CREATED", "BOOKING_RESCHEDULED", "BOOKING_CANCELLED", "BOOKING_CONFIRMED", "BOOKING_REJECTED", "BOOKING_COMPLETED", "BOOKING_NO_SHOW", "BOOKING_REOPENED"],
"secret": "<string>",
"version": "2021-10-20"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payloadTemplate: '{"content":"A new event has been scheduled","type":"{{type}}","name":"{{title}}","organizer":"{{organizer.name}}","booker":"{{attendees.0.name}}"}',
active: true,
subscriberUrl: '<string>',
triggers: [
'BOOKING_CREATED',
'BOOKING_RESCHEDULED',
'BOOKING_CANCELLED',
'BOOKING_CONFIRMED',
'BOOKING_REJECTED',
'BOOKING_COMPLETED',
'BOOKING_NO_SHOW',
'BOOKING_REOPENED'
],
secret: '<string>',
version: '2021-10-20'
})
};

fetch('https://api.cal.com/v2/webhooks/{webhookId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cal.com/v2/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'payloadTemplate' => '{"content":"A new event has been scheduled","type":"{{type}}","name":"{{title}}","organizer":"{{organizer.name}}","booker":"{{attendees.0.name}}"}',
'active' => true,
'subscriberUrl' => '<string>',
'triggers' => [
'BOOKING_CREATED',
'BOOKING_RESCHEDULED',
'BOOKING_CANCELLED',
'BOOKING_CONFIRMED',
'BOOKING_REJECTED',
'BOOKING_COMPLETED',
'BOOKING_NO_SHOW',
'BOOKING_REOPENED'
],
'secret' => '<string>',
'version' => '2021-10-20'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.cal.com/v2/webhooks/{webhookId}"

payload := strings.NewReader("{\n \"payloadTemplate\": \"{\\\"content\\\":\\\"A new event has been scheduled\\\",\\\"type\\\":\\\"{{type}}\\\",\\\"name\\\":\\\"{{title}}\\\",\\\"organizer\\\":\\\"{{organizer.name}}\\\",\\\"booker\\\":\\\"{{attendees.0.name}}\\\"}\",\n \"active\": true,\n \"subscriberUrl\": \"<string>\",\n \"triggers\": [\n \"BOOKING_CREATED\",\n \"BOOKING_RESCHEDULED\",\n \"BOOKING_CANCELLED\",\n \"BOOKING_CONFIRMED\",\n \"BOOKING_REJECTED\",\n \"BOOKING_COMPLETED\",\n \"BOOKING_NO_SHOW\",\n \"BOOKING_REOPENED\"\n ],\n \"secret\": \"<string>\",\n \"version\": \"2021-10-20\"\n}")

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

req.Header.Add("Authorization", "<authorization>")
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.patch("https://api.cal.com/v2/webhooks/{webhookId}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"payloadTemplate\": \"{\\\"content\\\":\\\"A new event has been scheduled\\\",\\\"type\\\":\\\"{{type}}\\\",\\\"name\\\":\\\"{{title}}\\\",\\\"organizer\\\":\\\"{{organizer.name}}\\\",\\\"booker\\\":\\\"{{attendees.0.name}}\\\"}\",\n \"active\": true,\n \"subscriberUrl\": \"<string>\",\n \"triggers\": [\n \"BOOKING_CREATED\",\n \"BOOKING_RESCHEDULED\",\n \"BOOKING_CANCELLED\",\n \"BOOKING_CONFIRMED\",\n \"BOOKING_REJECTED\",\n \"BOOKING_COMPLETED\",\n \"BOOKING_NO_SHOW\",\n \"BOOKING_REOPENED\"\n ],\n \"secret\": \"<string>\",\n \"version\": \"2021-10-20\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cal.com/v2/webhooks/{webhookId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payloadTemplate\": \"{\\\"content\\\":\\\"A new event has been scheduled\\\",\\\"type\\\":\\\"{{type}}\\\",\\\"name\\\":\\\"{{title}}\\\",\\\"organizer\\\":\\\"{{organizer.name}}\\\",\\\"booker\\\":\\\"{{attendees.0.name}}\\\"}\",\n \"active\": true,\n \"subscriberUrl\": \"<string>\",\n \"triggers\": [\n \"BOOKING_CREATED\",\n \"BOOKING_RESCHEDULED\",\n \"BOOKING_CANCELLED\",\n \"BOOKING_CONFIRMED\",\n \"BOOKING_REJECTED\",\n \"BOOKING_COMPLETED\",\n \"BOOKING_NO_SHOW\",\n \"BOOKING_REOPENED\"\n ],\n \"secret\": \"<string>\",\n \"version\": \"2021-10-20\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": {
    "payloadTemplate": "{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}",
    "triggers": [],
    "userId": 123,
    "id": 123,
    "subscriberUrl": "<string>",
    "active": true,
    "secret": "<string>"
  }
}

Headers

Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_

Path Parameters

webhookId
string
required

Body

application/json
payloadTemplate
string

The template of the payload that will be sent to the subscriberUrl, check cal.com/docs/core-features/webhooks for more information

Example:

"{\"content\":\"A new event has been scheduled\",\"type\":\"{{type}}\",\"name\":\"{{title}}\",\"organizer\":\"{{organizer.name}}\",\"booker\":\"{{attendees.0.name}}\"}"

active
boolean
subscriberUrl
string
triggers
enum<string>[]
Available options:
BOOKING_CREATED,
BOOKING_PAYMENT_INITIATED,
BOOKING_PAID,
BOOKING_RESCHEDULED,
BOOKING_REQUESTED,
BOOKING_CANCELLED,
BOOKING_REJECTED,
BOOKING_NO_SHOW_UPDATED,
FORM_SUBMITTED,
MEETING_ENDED,
MEETING_STARTED,
RECORDING_READY,
INSTANT_MEETING,
INSTANT_MEETING_ACCEPTED,
RECORDING_TRANSCRIPTION_GENERATED,
OOO_CREATED,
AFTER_HOSTS_CAL_VIDEO_NO_SHOW,
AFTER_GUESTS_CAL_VIDEO_NO_SHOW,
FORM_SUBMITTED_NO_EVENT,
ROUTING_FORM_FALLBACK_HIT,
DELEGATION_CREDENTIAL_ERROR,
WRONG_ASSIGNMENT_REPORT
Example:
[
"BOOKING_CREATED",
"BOOKING_RESCHEDULED",
"BOOKING_CANCELLED",
"BOOKING_CONFIRMED",
"BOOKING_REJECTED",
"BOOKING_COMPLETED",
"BOOKING_NO_SHOW",
"BOOKING_REOPENED"
]
secret
string
version
enum<string>

The version of the webhook

Available options:
2021-10-20
Example:

"2021-10-20"

Response

200 - application/json
status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object
required