Create Webhook Subscription
curl --request POST \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions \
--header 'Content-Type: application/json' \
--data '
{
"event_types": [
"<string>"
],
"target_url": "<string>",
"oauth_config": {
"token_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
]
},
"custom_headers": {},
"description": "<string>",
"idempotency_key": "<string>"
}
'import requests
url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions"
payload = {
"event_types": ["<string>"],
"target_url": "<string>",
"oauth_config": {
"token_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": ["<string>"]
},
"custom_headers": {},
"description": "<string>",
"idempotency_key": "<string>"
}
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({
event_types: ['<string>'],
target_url: '<string>',
oauth_config: {
token_url: '<string>',
client_id: '<string>',
client_secret: '<string>',
scopes: ['<string>']
},
custom_headers: {},
description: '<string>',
idempotency_key: '<string>'
})
};
fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions', 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",
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([
'event_types' => [
'<string>'
],
'target_url' => '<string>',
'oauth_config' => [
'token_url' => '<string>',
'client_id' => '<string>',
'client_secret' => '<string>',
'scopes' => [
'<string>'
]
],
'custom_headers' => [
],
'description' => '<string>',
'idempotency_key' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"event_types\": [\n \"<string>\"\n ],\n \"target_url\": \"<string>\",\n \"oauth_config\": {\n \"token_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n },\n \"custom_headers\": {},\n \"description\": \"<string>\",\n \"idempotency_key\": \"<string>\"\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")
.header("Content-Type", "application/json")
.body("{\n \"event_types\": [\n \"<string>\"\n ],\n \"target_url\": \"<string>\",\n \"oauth_config\": {\n \"token_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n },\n \"custom_headers\": {},\n \"description\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions")
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 \"event_types\": [\n \"<string>\"\n ],\n \"target_url\": \"<string>\",\n \"oauth_config\": {\n \"token_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n },\n \"custom_headers\": {},\n \"description\": \"<string>\",\n \"idempotency_key\": \"<string>\"\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>"
}{
"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": "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
Create Webhook Subscription
Creates a new webhook subscription for the portfolio in the URL path. Returns the HMAC signing secret exactly once; store it securely.
POST
/
v1
/
portfolios
/
{portfolio_id}
/
webhooks
/
subscriptions
Create Webhook Subscription
curl --request POST \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions \
--header 'Content-Type: application/json' \
--data '
{
"event_types": [
"<string>"
],
"target_url": "<string>",
"oauth_config": {
"token_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": [
"<string>"
]
},
"custom_headers": {},
"description": "<string>",
"idempotency_key": "<string>"
}
'import requests
url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions"
payload = {
"event_types": ["<string>"],
"target_url": "<string>",
"oauth_config": {
"token_url": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"scopes": ["<string>"]
},
"custom_headers": {},
"description": "<string>",
"idempotency_key": "<string>"
}
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({
event_types: ['<string>'],
target_url: '<string>',
oauth_config: {
token_url: '<string>',
client_id: '<string>',
client_secret: '<string>',
scopes: ['<string>']
},
custom_headers: {},
description: '<string>',
idempotency_key: '<string>'
})
};
fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions', 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",
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([
'event_types' => [
'<string>'
],
'target_url' => '<string>',
'oauth_config' => [
'token_url' => '<string>',
'client_id' => '<string>',
'client_secret' => '<string>',
'scopes' => [
'<string>'
]
],
'custom_headers' => [
],
'description' => '<string>',
'idempotency_key' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"event_types\": [\n \"<string>\"\n ],\n \"target_url\": \"<string>\",\n \"oauth_config\": {\n \"token_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n },\n \"custom_headers\": {},\n \"description\": \"<string>\",\n \"idempotency_key\": \"<string>\"\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")
.header("Content-Type", "application/json")
.body("{\n \"event_types\": [\n \"<string>\"\n ],\n \"target_url\": \"<string>\",\n \"oauth_config\": {\n \"token_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n },\n \"custom_headers\": {},\n \"description\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/webhooks/subscriptions")
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 \"event_types\": [\n \"<string>\"\n ],\n \"target_url\": \"<string>\",\n \"oauth_config\": {\n \"token_url\": \"<string>\",\n \"client_id\": \"<string>\",\n \"client_secret\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n },\n \"custom_headers\": {},\n \"description\": \"<string>\",\n \"idempotency_key\": \"<string>\"\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>"
}{
"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": "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
CreateWebhookSubscriptionRequest specifies the events, destination, and authentication for a new subscription.
Response
A successful response.
CreateWebhookSubscriptionResponse returns the created subscription and its one-time HMAC secret.
Was this page helpful?