List webhook events
curl --request GET \
--url https://payments.coinbase.com/api/v1/webhook-events \
--header 'Authorization: <api-key>'import requests
url = "https://payments.coinbase.com/api/v1/webhook-events"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://payments.coinbase.com/api/v1/webhook-events', 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://payments.coinbase.com/api/v1/webhook-events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://payments.coinbase.com/api/v1/webhook-events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://payments.coinbase.com/api/v1/webhook-events")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://payments.coinbase.com/api/v1/webhook-events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"webhookEvents": [
{
"entity": "<string>",
"id": "<string>",
"paymentOperation": {
"entity": "<string>",
"id": "<string>",
"transactionHash": "<string>",
"params": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"payment": {
"entity": "<string>",
"id": "<string>",
"maxAmount": "<string>",
"token": "<string>",
"networkId": 123,
"payer": "<string>",
"signature": "<string>",
"receiver": "<string>",
"maxFeeBps": 123,
"minFeeBps": 123,
"feeReceiver": "<string>",
"salt": "<string>",
"paymentInfoHash": "<string>",
"nonce": "<string>",
"authorizationExpiry": "<string>",
"preApprovalExpiry": "<string>",
"refundExpiry": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"operator": "<string>",
"contractAddress": "<string>",
"authorizedAmount": "<string>",
"capturedAmount": "<string>",
"voidedAmount": "<string>",
"refundedAmount": "<string>",
"chargedAmount": "<string>",
"merchantId": "<string>"
},
"output": "<string>",
"error": "<string>",
"errorCode": "<string>",
"revertReason": "<string>",
"blockNumber": "<string>",
"metadata": {}
},
"rewardOperation": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reward": {
"id": "<string>",
"campaignAddress": "<string>",
"paymentInfoHash": "<string>",
"recipientAddress": "<string>",
"tokenAddress": "<string>",
"chainId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"amount": "<string>",
"transactionHash": "<string>",
"error": "<string>",
"errorCode": "<string>",
"revertReason": "<string>",
"blockNumber": "<string>"
},
"webhook": {
"entity": "<string>",
"id": "<string>",
"operatorCoinbaseUserId": "<string>",
"identifier": "<string>",
"description": "<string>",
"url": "<string>",
"events": [],
"secret": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"attempts": 123,
"maxRetries": 123,
"apiVersion": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deliveredAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"pagination": {
"limit": 123,
"next": "<string>"
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Webhook Events
List webhook events
Retrieve all webhook events for an operator.
GET
/
api
/
v1
/
webhook-events
List webhook events
curl --request GET \
--url https://payments.coinbase.com/api/v1/webhook-events \
--header 'Authorization: <api-key>'import requests
url = "https://payments.coinbase.com/api/v1/webhook-events"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://payments.coinbase.com/api/v1/webhook-events', 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://payments.coinbase.com/api/v1/webhook-events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://payments.coinbase.com/api/v1/webhook-events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://payments.coinbase.com/api/v1/webhook-events")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://payments.coinbase.com/api/v1/webhook-events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"webhookEvents": [
{
"entity": "<string>",
"id": "<string>",
"paymentOperation": {
"entity": "<string>",
"id": "<string>",
"transactionHash": "<string>",
"params": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"payment": {
"entity": "<string>",
"id": "<string>",
"maxAmount": "<string>",
"token": "<string>",
"networkId": 123,
"payer": "<string>",
"signature": "<string>",
"receiver": "<string>",
"maxFeeBps": 123,
"minFeeBps": 123,
"feeReceiver": "<string>",
"salt": "<string>",
"paymentInfoHash": "<string>",
"nonce": "<string>",
"authorizationExpiry": "<string>",
"preApprovalExpiry": "<string>",
"refundExpiry": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"operator": "<string>",
"contractAddress": "<string>",
"authorizedAmount": "<string>",
"capturedAmount": "<string>",
"voidedAmount": "<string>",
"refundedAmount": "<string>",
"chargedAmount": "<string>",
"merchantId": "<string>"
},
"output": "<string>",
"error": "<string>",
"errorCode": "<string>",
"revertReason": "<string>",
"blockNumber": "<string>",
"metadata": {}
},
"rewardOperation": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reward": {
"id": "<string>",
"campaignAddress": "<string>",
"paymentInfoHash": "<string>",
"recipientAddress": "<string>",
"tokenAddress": "<string>",
"chainId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"amount": "<string>",
"transactionHash": "<string>",
"error": "<string>",
"errorCode": "<string>",
"revertReason": "<string>",
"blockNumber": "<string>"
},
"webhook": {
"entity": "<string>",
"id": "<string>",
"operatorCoinbaseUserId": "<string>",
"identifier": "<string>",
"description": "<string>",
"url": "<string>",
"events": [],
"secret": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"attempts": 123,
"maxRetries": 123,
"apiVersion": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deliveredAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"pagination": {
"limit": 123,
"next": "<string>"
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
Authorization header using the Bearer scheme. Learn more about JWT tokens in the Coinbase Developer Portal.
Query Parameters
Limit
Maximum number of webhook events to return. Default is 10, Max is 25.
Next
Next item to use for pagination.
Was this page helpful?
⌘I