Rotate Webhook HMAC Secret
curl --request POST \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret \
--header 'Content-Type: application/json' \
--data '
{
"revoke_previous_immediately": true
}
'import requests
url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret"
payload = { "revoke_previous_immediately": True }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({revoke_previous_immediately: true})
};
fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret', 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.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret",
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([
'revoke_previous_immediately' => true
]),
CURLOPT_HTTPHEADER => [
"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.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret"
payload := strings.NewReader("{\n \"revoke_previous_immediately\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret")
.header("Content-Type", "application/json")
.body("{\n \"revoke_previous_immediately\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"revoke_previous_immediately\": true\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"subscription_id": "<string>",
"event_types": [
"<string>"
],
"target_url": "<string>",
"auth_type": "WEBHOOK_AUTH_TYPE_HMAC",
"oauth_config": {
"token_url": "<string>",
"client_id": "<string>",
"scopes": [
"<string>"
]
},
"custom_headers": {},
"is_enabled": true,
"description": "<string>",
"created_by": "<string>",
"updated_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"health_status": "WEBHOOK_HEALTH_STATUS_HEALTHY",
"version": "<string>"
},
"hmac_secret": "<string>",
"previous_secret_expires_at": "2023-11-07T05:31:56Z"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"subcode": "PORTFOLIO_ID_REQUIRED",
"trace_id": "<string>"
}{
"code": "PERMISSION_DENIED",
"message": "<string>",
"subcode": "AUTH_RESOURCE_ACCESS_DENIED",
"trace_id": "<string>"
}{
"code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"subcode": "WEBHOOK_SUBSCRIPTION_NOT_FOUND",
"trace_id": "<string>"
}{
"code": "RATE_LIMIT_EXCEEDED",
"message": "<string>",
"subcode": "SERVER_RATE_LIMIT_EXCEEDED",
"trace_id": "<string>"
}{
"code": "INTERNAL_ERROR",
"message": "<string>",
"subcode": "AUTH_AUTHORIZATION_FAILED",
"trace_id": "<string>"
}{
"code": "SERVICE_UNAVAILABLE",
"message": "<string>",
"subcode": "SERVER_MAINTENANCE_MODE_ACTIVE",
"trace_id": "<string>"
}Webhooks
Rotate Webhook HMAC Secret
Issues a new HMAC signing secret for the subscription and returns the plaintext exactly once. By default the previous secret remains valid for a server-configured grace window; set revoke_previous_immediately to invalidate it at once.
POST
/
v1
/
portfolios
/
{portfolio_id}
/
webhooks
/
subscriptions
/
{subscription_id}
/
rotate-hmac-secret
Rotate Webhook HMAC Secret
curl --request POST \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret \
--header 'Content-Type: application/json' \
--data '
{
"revoke_previous_immediately": true
}
'import requests
url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret"
payload = { "revoke_previous_immediately": True }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({revoke_previous_immediately: true})
};
fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret', 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.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret",
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([
'revoke_previous_immediately' => true
]),
CURLOPT_HTTPHEADER => [
"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.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret"
payload := strings.NewReader("{\n \"revoke_previous_immediately\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret")
.header("Content-Type", "application/json")
.body("{\n \"revoke_previous_immediately\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions/{subscription_id}/rotate-hmac-secret")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"revoke_previous_immediately\": true\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"subscription_id": "<string>",
"event_types": [
"<string>"
],
"target_url": "<string>",
"auth_type": "WEBHOOK_AUTH_TYPE_HMAC",
"oauth_config": {
"token_url": "<string>",
"client_id": "<string>",
"scopes": [
"<string>"
]
},
"custom_headers": {},
"is_enabled": true,
"description": "<string>",
"created_by": "<string>",
"updated_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"health_status": "WEBHOOK_HEALTH_STATUS_HEALTHY",
"version": "<string>"
},
"hmac_secret": "<string>",
"previous_secret_expires_at": "2023-11-07T05:31:56Z"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"subcode": "PORTFOLIO_ID_REQUIRED",
"trace_id": "<string>"
}{
"code": "PERMISSION_DENIED",
"message": "<string>",
"subcode": "AUTH_RESOURCE_ACCESS_DENIED",
"trace_id": "<string>"
}{
"code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"subcode": "WEBHOOK_SUBSCRIPTION_NOT_FOUND",
"trace_id": "<string>"
}{
"code": "RATE_LIMIT_EXCEEDED",
"message": "<string>",
"subcode": "SERVER_RATE_LIMIT_EXCEEDED",
"trace_id": "<string>"
}{
"code": "INTERNAL_ERROR",
"message": "<string>",
"subcode": "AUTH_AUTHORIZATION_FAILED",
"trace_id": "<string>"
}{
"code": "SERVICE_UNAVAILABLE",
"message": "<string>",
"subcode": "SERVER_MAINTENANCE_MODE_ACTIVE",
"trace_id": "<string>"
}Body
application/json
Response
A successful response.
RotateWebhookHMACSecretResponse is the response message for rotating a webhook HMAC signing secret.
Was this page helpful?