Fully replace a Partner webhook endpoint
curl --request PUT \
--url https://api.stabyl.com/v1/partner/webhooks/{webhook_id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"enabled": true,
"event_types": [],
"url": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}"
payload = {
"enabled": True,
"event_types": [],
"url": "<string>",
"description": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, event_types: [], url: '<string>', description: '<string>'})
};
fetch('https://api.stabyl.com/v1/partner/webhooks/{webhook_id}', 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.stabyl.com/v1/partner/webhooks/{webhook_id}",
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([
'enabled' => true,
'event_types' => [
],
'url' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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.stabyl.com/v1/partner/webhooks/{webhook_id}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"event_types\": [],\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-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.put("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"event_types\": [],\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"event_types\": [],\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "2026-07-12T11:00:00Z",
"description": "Production event receiver",
"event_types": [
"deposit.success",
"withdrawal.success"
],
"id": "01980d95-5537-76aa-88a8-ad59117632ef",
"secret_version": 1,
"status": "enabled",
"updated_at": "2026-07-12T11:00:00Z",
"url": "https://partner.example.com/stabyl/events"
},
"status": "success"
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "invalid request parameters"
},
"status": "error"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "missing X-Api-Key header"
},
"status": "error"
}{
"error": {
"code": "MISSING_SCOPE",
"message": "missing_scope"
},
"status": "error"
}{
"error": {
"code": "NOT_FOUND",
"message": "resource not found"
},
"status": "error"
}{
"error": {
"code": "WEBHOOK_ACTIVE_LIMIT_REACHED",
"message": "webhook_active_limit_reached"
},
"status": "error"
}{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "webhook destination is not an allowed public HTTPS URL"
},
"status": "error"
}{
"error": {
"code": "PARTNER_WEBHOOKS_DISABLED",
"message": "partner_webhooks_disabled"
},
"status": "error"
}Webhooks
Fully replace a Partner webhook endpoint
Fully replaces URL, nullable description, enabled state, and exact subscription set atomically. Replacing an endpoint never rotates its signing secret.
PUT
/
partner
/
webhooks
/
{webhook_id}
Fully replace a Partner webhook endpoint
curl --request PUT \
--url https://api.stabyl.com/v1/partner/webhooks/{webhook_id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"enabled": true,
"event_types": [],
"url": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.stabyl.com/v1/partner/webhooks/{webhook_id}"
payload = {
"enabled": True,
"event_types": [],
"url": "<string>",
"description": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, event_types: [], url: '<string>', description: '<string>'})
};
fetch('https://api.stabyl.com/v1/partner/webhooks/{webhook_id}', 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.stabyl.com/v1/partner/webhooks/{webhook_id}",
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([
'enabled' => true,
'event_types' => [
],
'url' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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.stabyl.com/v1/partner/webhooks/{webhook_id}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"event_types\": [],\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-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.put("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"event_types\": [],\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stabyl.com/v1/partner/webhooks/{webhook_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"event_types\": [],\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "2026-07-12T11:00:00Z",
"description": "Production event receiver",
"event_types": [
"deposit.success",
"withdrawal.success"
],
"id": "01980d95-5537-76aa-88a8-ad59117632ef",
"secret_version": 1,
"status": "enabled",
"updated_at": "2026-07-12T11:00:00Z",
"url": "https://partner.example.com/stabyl/events"
},
"status": "success"
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "invalid request parameters"
},
"status": "error"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "missing X-Api-Key header"
},
"status": "error"
}{
"error": {
"code": "MISSING_SCOPE",
"message": "missing_scope"
},
"status": "error"
}{
"error": {
"code": "NOT_FOUND",
"message": "resource not found"
},
"status": "error"
}{
"error": {
"code": "WEBHOOK_ACTIVE_LIMIT_REACHED",
"message": "webhook_active_limit_reached"
},
"status": "error"
}{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "webhook destination is not an allowed public HTTPS URL"
},
"status": "error"
}{
"error": {
"code": "PARTNER_WEBHOOKS_DISABLED",
"message": "partner_webhooks_disabled"
},
"status": "error"
}Authorizations
API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers.
Path Parameters
Webhook endpoint identifier
Body
application/json
Exact Partner webhook topics supported by the V1 public contract.
Available options:
deposit.action_required, deposit.success, deposit.failed, withdrawal.success, withdrawal.failed, exchange.accepted, exchange.filled, exchange.replaced, exchange.cancelled, exchange.rejected Was this page helpful?
⌘I