curl --request POST \
--url https://api.cargado.com/webhooks/endpoint/update \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"endpointId": "<string>",
"url": "<string>",
"description": "<string>",
"filterTypes": [],
"channels": [
"<string>"
],
"throttleRate": 500,
"disabled": true,
"metadata": {}
}
'import requests
url = "https://api.cargado.com/webhooks/endpoint/update"
payload = {
"endpointId": "<string>",
"url": "<string>",
"description": "<string>",
"filterTypes": [],
"channels": ["<string>"],
"throttleRate": 500,
"disabled": True,
"metadata": {}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpointId: '<string>',
url: '<string>',
description: '<string>',
filterTypes: [],
channels: ['<string>'],
throttleRate: 500,
disabled: true,
metadata: {}
})
};
fetch('https://api.cargado.com/webhooks/endpoint/update', 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.cargado.com/webhooks/endpoint/update",
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([
'endpointId' => '<string>',
'url' => '<string>',
'description' => '<string>',
'filterTypes' => [
],
'channels' => [
'<string>'
],
'throttleRate' => 500,
'disabled' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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.cargado.com/webhooks/endpoint/update"
payload := strings.NewReader("{\n \"endpointId\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\",\n \"filterTypes\": [],\n \"channels\": [\n \"<string>\"\n ],\n \"throttleRate\": 500,\n \"disabled\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
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.cargado.com/webhooks/endpoint/update")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endpointId\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\",\n \"filterTypes\": [],\n \"channels\": [\n \"<string>\"\n ],\n \"throttleRate\": 500,\n \"disabled\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cargado.com/webhooks/endpoint/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endpointId\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\",\n \"filterTypes\": [],\n \"channels\": [\n \"<string>\"\n ],\n \"throttleRate\": 500,\n \"disabled\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"description": "<string>",
"filterTypes": [],
"channels": [
"<string>"
],
"throttleRate": 123,
"disabled": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"message": "<string>"
}Update webhook endpoint
Patch a webhook endpoint. Only the fields you include in the body are changed — everything else stays as-is.
curl --request POST \
--url https://api.cargado.com/webhooks/endpoint/update \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"endpointId": "<string>",
"url": "<string>",
"description": "<string>",
"filterTypes": [],
"channels": [
"<string>"
],
"throttleRate": 500,
"disabled": true,
"metadata": {}
}
'import requests
url = "https://api.cargado.com/webhooks/endpoint/update"
payload = {
"endpointId": "<string>",
"url": "<string>",
"description": "<string>",
"filterTypes": [],
"channels": ["<string>"],
"throttleRate": 500,
"disabled": True,
"metadata": {}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpointId: '<string>',
url: '<string>',
description: '<string>',
filterTypes: [],
channels: ['<string>'],
throttleRate: 500,
disabled: true,
metadata: {}
})
};
fetch('https://api.cargado.com/webhooks/endpoint/update', 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.cargado.com/webhooks/endpoint/update",
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([
'endpointId' => '<string>',
'url' => '<string>',
'description' => '<string>',
'filterTypes' => [
],
'channels' => [
'<string>'
],
'throttleRate' => 500,
'disabled' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$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.cargado.com/webhooks/endpoint/update"
payload := strings.NewReader("{\n \"endpointId\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\",\n \"filterTypes\": [],\n \"channels\": [\n \"<string>\"\n ],\n \"throttleRate\": 500,\n \"disabled\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
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.cargado.com/webhooks/endpoint/update")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endpointId\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\",\n \"filterTypes\": [],\n \"channels\": [\n \"<string>\"\n ],\n \"throttleRate\": 500,\n \"disabled\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cargado.com/webhooks/endpoint/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endpointId\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\",\n \"filterTypes\": [],\n \"channels\": [\n \"<string>\"\n ],\n \"throttleRate\": 500,\n \"disabled\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"description": "<string>",
"filterTypes": [],
"channels": [
"<string>"
],
"throttleRate": 123,
"disabled": true,
"metadata": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"message": "<string>"
}Authorizations
Body
ID of the endpoint to update
1 - 256The HTTPS URL where webhook payloads will be sent via POST
^https://"https://api.example.com/webhooks"
A label for this endpoint, visible in the dashboard and API responses
256Only deliver events matching these types. Omit to keep current filter. Pass an empty array to receive all event types.
50Event types available for webhook subscriptions.
Use these values in filterTypes to receive only specific events.
bid.created, bid.accepted, bid.rejected, bid.revoked, bid.closed, bid.countered, bid.counter_accepted, bid.counter_revoked, bid.counter_rejected Channels to subscribe to. Omit to keep current channels.
50Max events per second delivered to this endpoint. Omit to keep current limit.
1 <= x <= 1000Set to true to pause delivery to this endpoint without deleting it
Arbitrary key-value pairs to attach to this endpoint. Replaces existing metadata. Maximum 50 entries.
Show child attributes
Show child attributes
Response
Ok
Unique identifier for this endpoint
The HTTPS URL where webhook payloads are delivered
Label for this endpoint
Event types this endpoint is subscribed to, or null if subscribed to all
Event types available for webhook subscriptions.
Use these values in filterTypes to receive only specific events.
bid.created, bid.accepted, bid.rejected, bid.revoked, bid.closed, bid.countered, bid.counter_accepted, bid.counter_revoked, bid.counter_rejected Channels this endpoint listens on, or null if listening on all
Max events per second delivered to this endpoint, or null for unlimited
Whether delivery to this endpoint is paused
Arbitrary key-value pairs attached to this endpoint
Show child attributes
Show child attributes
ISO 8601 timestamp when the endpoint was created
ISO 8601 timestamp when the endpoint was last modified

