Update application webhook
Updates the URL or active status of a webhook configuration.
curl -X PATCH "https://api.example.com/api/v1/applications/example_string/webhooks/example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-d '{
"url": "https://merchant.example.com/hooks/v2",
"isActive": true
}'
import requests
import json
url = "https://api.example.com/api/v1/applications/example_string/webhooks/example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
data = {
"url": "https://merchant.example.com/hooks/v2",
"isActive": true
}
response = requests.patch(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.example.com/api/v1/applications/example_string/webhooks/example_string", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)"
},
body: JSON.stringify({
"url": "https://merchant.example.com/hooks/v2",
"isActive": true
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"url": "https://merchant.example.com/hooks/v2",
"isActive": true
}`)
req, err := http.NewRequest("PATCH", "https://api.example.com/api/v1/applications/example_string/webhooks/example_string", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.example.com/api/v1/applications/example_string/webhooks/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request.body = '{
"url": "https://merchant.example.com/hooks/v2",
"isActive": true
}'
response = http.request(request)
puts response.body
{
"id": "8a1c2f9e-3d4b-4f5a-9b6c-7d8e9f0a1b2c",
"url": "https://merchant.example.com/webhooks/kadosei",
"isActive": true,
"keyFingerprint": "whsec_****a3f2",
"signingSecret": "whsec_full_secret_value",
"subscribedEvents": [
"session.completed",
"session.expired"
],
"lastTestAt": "2026-04-20T12:34:56.000Z",
"lastTestStatus": "SUCCEEDED",
"createdAt": "2026-01-15T08:00:00.000Z",
"updatedAt": "2026-04-01T09:30:00.000Z"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
{
"error": "Error",
"message": "Service temporarily unavailable.",
"code": 502
}
{
"error": "Error",
"message": "Request timed out.",
"code": 504
}
/api/v1/applications/{applicationId}/webhooks/{webhookId}Target server for requests. Edit to use your own host.
Bearer token (JWT) - just enter the token, "Bearer" prefix will be added automatically
ID of the application that owns the webhook.
ID of the webhook configuration to update.
The media type of the request body
HTTPS endpoint on the merchant server that receives webhooks.
Whether this webhook configuration is active.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). Authentication token required.
Path Parameters
ID of the application that owns the webhook.
ID of the webhook configuration to update.
Body
HTTPS endpoint on the merchant server that receives webhooks.
https://merchant.example.com/hooks/v2Responses
ID of the webhook configuration.
Endpoint URL that receives webhook deliveries.
Whether this webhook configuration is currently active.
Fingerprint of the signing key used to sign webhook deliveries.
Webhook signing secret. Only returned when creating a webhook; store securely.
Event types this webhook is subscribed to.
Timestamp of the most recent test delivery, if any.
Status of the most recent test delivery, if any.
When this webhook configuration was created.
When this webhook configuration was last updated.