Get webhook subscription matched event

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}', 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.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}",
  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: Bearer <token>"
  ],
]);

$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://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "matchId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "eventType": "onchain.activity.detected",
  "createdAt": "2025-01-15T10:30:00Z",
  "occurredAt": "2025-01-15T10:29:58Z",
  "succeededAt": "2025-01-15T10:30:02Z",
  "attemptCount": 1,
  "status": "succeeded",
  "payload": {
    "eventId": "00000000-0000-0000-0000-000000000000",
    "eventType": "onchain.activity.detected",
    "data": {
      "foo": "bar"
    }
  },
  "latestAttempt": {
    "result": "success",
    "attemptedAt": "2025-01-15T10:30:00Z",
    "statusCode": 200,
    "attemptNumber": 1,
    "requestHeaders": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "targetUrl": "https://example.com/webhook"
  }
}

GET

data

webhooks

subscriptions

{subscriptionId}

matches

{matchId}

Get webhook subscription matched event

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}', 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.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}",
  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: Bearer <token>"
  ],
]);

$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://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}/matches/{matchId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "matchId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "eventType": "onchain.activity.detected",
  "createdAt": "2025-01-15T10:30:00Z",
  "occurredAt": "2025-01-15T10:29:58Z",
  "succeededAt": "2025-01-15T10:30:02Z",
  "attemptCount": 1,
  "status": "succeeded",
  "payload": {
    "eventId": "00000000-0000-0000-0000-000000000000",
    "eventType": "onchain.activity.detected",
    "data": {
      "foo": "bar"
    }
  },
  "latestAttempt": {
    "result": "success",
    "attemptedAt": "2025-01-15T10:30:00Z",
    "statusCode": 200,
    "attemptNumber": 1,
    "requestHeaders": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "targetUrl": "https://example.com/webhook"
  }
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Path Parameters

subscriptionId

string<uuid>

required

Unique identifier for the webhook subscription.

Pattern: ^[a-f0-9\-]{36}$

matchId

string<uuid>

required

Unique identifier for the webhook matched event.

Pattern: ^[a-f0-9\-]{36}$

Response

Webhook matched event retrieved successfully.

Details of an event that matched a webhook subscription.

eventId

string<uuid>

required

Unique identifier for the webhook event.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

matchId

string<uuid>

required

Unique identifier for the webhook match.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

subscriptionId

string<uuid>

required

Unique identifier for the webhook subscription.

Example:

"123e4567-e89b-12d3-a456-426614174000"

eventType

string

required

The type of event that was delivered (e.g., "onchain.activity.detected").

Example:

"onchain.activity.detected"

status

enum<string>

required

Current state of the matched event.

retrying: The event is currently being retried. For when the next attempt will occur, see nextAttemptAt.
abandoned: The event was abandoned. This means the subscription was disabled during the retry lifecycle.
succeeded: The event was successfully delivered to the target URL.
failed: The event delivery failed due to reaching the maximum number of retry attempts or other non-retryable failure such as a subscription misconfiguration.

Available options:

retrying,

abandoned,

succeeded,

failed

Example:

"succeeded"

createdAt

string<date-time>

required

Timestamp when the underlying event was processed by the webhook system.

If an event is replayed, a new createdAt will be recorded at the time of replay.

Example:

"2025-01-15T10:30:00Z"

occurredAt

string<date-time>

required

Timestamp when the underlying event actually occurred.

This is different from createdAt, which is the timestamp the event reached the webhook system and matched the subscription.

If an event is replayed, the occurredAt timestamp will remain the same.

Example:

"2025-01-15T10:29:58Z"

attemptCount

integer

required

Number of delivery attempts so far.

Includes the initial attempt and all retry attempts.

Example:

1

succeededAt

string<date-time>

Timestamp when the matched event was successfully delivered to the target URL. Only present if status is succeeded.

Example:

"2025-01-15T10:30:02Z"

payload

object

The payload of the event.

Example:

{
  "eventId": "00000000-0000-0000-0000-000000000000",
  "eventType": "onchain.activity.detected",
  "data": { "foo": "bar" }
}

latestAttempt

object

Outcome and timing of a single webhook delivery attempt.

Show child attributes

nextAttemptAt

string<date-time>

Timestamp when the matched event will be retried. Only supplied if the matched event's status is retrying.

Example:

"2025-01-15T10:30:02Z"