Update a webhook
curl --request PUT \
--url https://api.venlyfinance.com/v1/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://client.example/hooks/venly-v2",
"name": "Production events",
"authenticationMethod": {
"type": "BASIC_AUTHENTICATION",
"username": "venly",
"password": "s3cr3t-rotated"
}
}
'import requests
url = "https://api.venlyfinance.com/v1/webhooks/{webhookId}"
payload = {
"url": "https://client.example/hooks/venly-v2",
"name": "Production events",
"authenticationMethod": {
"type": "BASIC_AUTHENTICATION",
"username": "venly",
"password": "s3cr3t-rotated"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://client.example/hooks/venly-v2',
name: 'Production events',
authenticationMethod: {type: 'BASIC_AUTHENTICATION', username: 'venly', password: 's3cr3t-rotated'}
})
};
fetch('https://api.venlyfinance.com/v1/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.venlyfinance.com/v1/webhooks/{webhookId}",
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([
'url' => 'https://client.example/hooks/venly-v2',
'name' => 'Production events',
'authenticationMethod' => [
'type' => 'BASIC_AUTHENTICATION',
'username' => 'venly',
'password' => 's3cr3t-rotated'
]
]),
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.venlyfinance.com/v1/webhooks/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"https://client.example/hooks/venly-v2\",\n \"name\": \"Production events\",\n \"authenticationMethod\": {\n \"type\": \"BASIC_AUTHENTICATION\",\n \"username\": \"venly\",\n \"password\": \"s3cr3t-rotated\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.venlyfinance.com/v1/webhooks/{webhookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://client.example/hooks/venly-v2\",\n \"name\": \"Production events\",\n \"authenticationMethod\": {\n \"type\": \"BASIC_AUTHENTICATION\",\n \"username\": \"venly\",\n \"password\": \"s3cr3t-rotated\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://client.example/hooks/venly-v2\",\n \"name\": \"Production events\",\n \"authenticationMethod\": {\n \"type\": \"BASIC_AUTHENTICATION\",\n \"username\": \"venly\",\n \"password\": \"s3cr3t-rotated\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"id": "wh_8842f19c",
"url": "<string>",
"status": "ACTIVE",
"name": "<string>",
"authenticationMethod": {
"type": "API_KEY",
"headerName": "X-Webhook-Key"
}
}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}Webhooks
Update a webhook
Replace a registered webhook’s URL, name, or authentication.
PUT
/
webhooks
/
{webhookId}
Update a webhook
curl --request PUT \
--url https://api.venlyfinance.com/v1/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://client.example/hooks/venly-v2",
"name": "Production events",
"authenticationMethod": {
"type": "BASIC_AUTHENTICATION",
"username": "venly",
"password": "s3cr3t-rotated"
}
}
'import requests
url = "https://api.venlyfinance.com/v1/webhooks/{webhookId}"
payload = {
"url": "https://client.example/hooks/venly-v2",
"name": "Production events",
"authenticationMethod": {
"type": "BASIC_AUTHENTICATION",
"username": "venly",
"password": "s3cr3t-rotated"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://client.example/hooks/venly-v2',
name: 'Production events',
authenticationMethod: {type: 'BASIC_AUTHENTICATION', username: 'venly', password: 's3cr3t-rotated'}
})
};
fetch('https://api.venlyfinance.com/v1/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.venlyfinance.com/v1/webhooks/{webhookId}",
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([
'url' => 'https://client.example/hooks/venly-v2',
'name' => 'Production events',
'authenticationMethod' => [
'type' => 'BASIC_AUTHENTICATION',
'username' => 'venly',
'password' => 's3cr3t-rotated'
]
]),
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.venlyfinance.com/v1/webhooks/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"https://client.example/hooks/venly-v2\",\n \"name\": \"Production events\",\n \"authenticationMethod\": {\n \"type\": \"BASIC_AUTHENTICATION\",\n \"username\": \"venly\",\n \"password\": \"s3cr3t-rotated\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.venlyfinance.com/v1/webhooks/{webhookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://client.example/hooks/venly-v2\",\n \"name\": \"Production events\",\n \"authenticationMethod\": {\n \"type\": \"BASIC_AUTHENTICATION\",\n \"username\": \"venly\",\n \"password\": \"s3cr3t-rotated\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://client.example/hooks/venly-v2\",\n \"name\": \"Production events\",\n \"authenticationMethod\": {\n \"type\": \"BASIC_AUTHENTICATION\",\n \"username\": \"venly\",\n \"password\": \"s3cr3t-rotated\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"id": "wh_8842f19c",
"url": "<string>",
"status": "ACTIVE",
"name": "<string>",
"authenticationMethod": {
"type": "API_KEY",
"headerName": "X-Webhook-Key"
}
}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}Requires scope:
Use this to rotate an API key or basic-auth password.
manage:webhooks — see Required scopes.
Replaces the configuration of an existing webhook.
This is a full replacement, not a partial patch. Send every field you want to keep — including
authenticationMethod with its secret, since secrets are never returned by a read and so cannot be carried over implicitly.Authorizations
OAuth2 client credentials flow. Token endpoints:
Path Parameters
Unique webhook identifier
Body
application/json
Replaces an existing webhook's configuration. Same shape and validation as registration — a full replacement, not a partial patch.
Absolute https:// endpoint the webhook delivers to
Maximum string length:
2048Authentication applied to outbound webhook deliveries, discriminated by type. Secret fields
(apiKey, password) are accepted on input and omitted from every read response.
- Option 1
- Option 2
Show child attributes
Show child attributes
Maximum string length:
255Was this page helpful?

