Webhooks
Update webhook destination
Workspace admin only. Saving runs two verification probes against the
URL: a GET that must answer with the Verify Token, and an empty POST
that must return a 2xx. Both probes carry
X-HookMyApp-Probe: webhook-verification and are unsigned — real
deliveries are always signed with X-HookMyApp-Signature-256. A
failed probe rejects the update with
WEBHOOK_URL_VERIFICATION_FAILED.
PUT
/
webhook-config
/
{channelId}
Update webhook destination
curl --request PUT \
--url https://api.hookmyapp.com/webhook-config/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <x-workspace-id>' \
--data '
{
"webhookUrl": "<string>",
"verifyToken": "<string>"
}
'import requests
url = "https://api.hookmyapp.com/webhook-config/{channelId}"
payload = {
"webhookUrl": "<string>",
"verifyToken": "<string>"
}
headers = {
"X-Workspace-Id": "<x-workspace-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Workspace-Id': '<x-workspace-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({webhookUrl: '<string>', verifyToken: '<string>'})
};
fetch('https://api.hookmyapp.com/webhook-config/{channelId}', 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.hookmyapp.com/webhook-config/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'webhookUrl' => '<string>',
'verifyToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Workspace-Id: <x-workspace-id>"
],
]);
$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.hookmyapp.com/webhook-config/{channelId}"
payload := strings.NewReader("{\n \"webhookUrl\": \"<string>\",\n \"verifyToken\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
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.put("https://api.hookmyapp.com/webhook-config/{channelId}")
.header("X-Workspace-Id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"<string>\",\n \"verifyToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hookmyapp.com/webhook-config/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"<string>\",\n \"verifyToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 403,
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}Authorizations
Authorization: Bearer hmok_... API key or a dashboard session token
Headers
Workspace ID for the request
Pattern:
^ws_[A-Za-z0-9]{8}$Path Parameters
Pattern:
^ch_[A-Za-z0-9]{8}$Response
Updated config
⌘I
Update webhook destination
curl --request PUT \
--url https://api.hookmyapp.com/webhook-config/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Id: <x-workspace-id>' \
--data '
{
"webhookUrl": "<string>",
"verifyToken": "<string>"
}
'import requests
url = "https://api.hookmyapp.com/webhook-config/{channelId}"
payload = {
"webhookUrl": "<string>",
"verifyToken": "<string>"
}
headers = {
"X-Workspace-Id": "<x-workspace-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'X-Workspace-Id': '<x-workspace-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({webhookUrl: '<string>', verifyToken: '<string>'})
};
fetch('https://api.hookmyapp.com/webhook-config/{channelId}', 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.hookmyapp.com/webhook-config/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'webhookUrl' => '<string>',
'verifyToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Workspace-Id: <x-workspace-id>"
],
]);
$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.hookmyapp.com/webhook-config/{channelId}"
payload := strings.NewReader("{\n \"webhookUrl\": \"<string>\",\n \"verifyToken\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
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.put("https://api.hookmyapp.com/webhook-config/{channelId}")
.header("X-Workspace-Id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"<string>\",\n \"verifyToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hookmyapp.com/webhook-config/{channelId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"<string>\",\n \"verifyToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 403,
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}