Skip to main content
GET
/
v2
/
data
/
webhooks
/
subscriptions
/
{subscriptionId}
Get webhook subscription
curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId} \
  --header 'Authorization: Bearer <token>'
{
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "eventTypes": [
    "onchain.activity.detected"
  ],
  "isEnabled": true,
  "labels": {
    "contract_address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
    "event_name": "Transfer",
    "network": "base-mainnet",
    "transaction_to": "0xf5042e6ffac5a625d4e7848e0b01373d8eb9e222"
  },
  "description": "USDC Transfer events to specific address.",
  "createdAt": "2025-11-12T09:19:52.051Z",
  "updatedAt": "2025-11-13T11:30:00.000Z",
  "metadata": {
    "secret": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "secret": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "target": {
    "url": "https://api.example.com/webhooks"
  }
}

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}$

Response

Webhook subscription details retrieved successfully.

Response containing webhook subscription details.

​
createdAt
string<date-time>
required

When the subscription was created.

Example:

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

​
eventTypes
enum<string>[]
required

Types of events to subscribe to. Event types follow a dot-separated format: service.resource.verb (e.g., "onchain.activity.detected", "wallet.activity.detected", "onramp.transaction.created", "acceptance.payment_session.authorization_succeeded").

A webhook event type identifier following dot-separated format: <domain>.<entity>.<verb> (e.g., "onchain.activity.detected").

Available options:
payments.transfers.quoted,
payments.transfers.processing,
payments.transfers.completed,
payments.transfers.failed,
payments.transfers.expired,
payments.transfers.travel_rule_incomplete,
payments.transfers.travel_rule_completed,
acceptance.payment.authorized,
acceptance.payment.captured,
acceptance.payment.charged,
acceptance.payment.voided,
acceptance.payment.refunded,
acceptance.payment.reconciled,
acceptance.reward.allocated,
acceptance.reward.distributed,
acceptance.reward.deallocated,
acceptance.reward.sent,
reporting.report.completed,
reporting.report.failed,
reporting.delivery.succeeded,
reporting.delivery.failed,
acceptance.payment_session.created,
acceptance.payment_session.canceled,
acceptance.payment_session.authorization_pending,
acceptance.payment_session.authorization_succeeded,
acceptance.payment_session.authorization_failed,
acceptance.payment_session.capture_pending,
acceptance.payment_session.capture_succeeded,
acceptance.payment_session.capture_failed,
acceptance.payment_session.refund_pending,
acceptance.payment_session.refund_succeeded,
acceptance.payment_session.refund_failed,
acceptance.payment_session.void_pending,
acceptance.payment_session.void_succeeded,
acceptance.payment_session.void_failed,
acceptance.disbursement.pending,
acceptance.disbursement.succeeded,
acceptance.disbursement.failed,
oauth.sign_in.completed,
oauth.mfa.completed,
oauth.sign_up.completed
Example:
["onchain.activity.detected"]
​
isEnabled
boolean
required

Whether the subscription is enabled.

Example:

true

​
secret
string<uuid>
required

Secret for webhook signature validation.

Example:

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

​
subscriptionId
string<uuid>
required

Unique identifier for the subscription.

Example:

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

​
target
object
required

Target configuration for webhook delivery. Specifies the destination URL and any custom headers to include in webhook requests.

Example:
{
  "url": "https://api.example.com/webhooks",
  "headers": {
    "Authorization": "Bearer token123",
    "Content-Type": "application/json"
  }
}
​
updatedAt
string<date-time>

When the subscription was last updated.

Example:

"2025-01-16T14:00:00Z"

​
description
string

Description of the webhook subscription.

Maximum string length: 500
Example:

"Subscription for token transfer events"

​
metadata
object

Additional metadata for the subscription.

Example:
{
  "customer_id": "cust_12345",
  "order_reference": "order-67890",
  "secret": "123e4567-e89b-12d3-a456-426614174000"
}
​
labels
object

Multi-label filters using total overlap logic. Total overlap means the subscription only triggers when events contain ALL these key-value pairs. Present when subscription uses multi-label format.

Example:
{
  "env": "dev",
  "team": "payments",
  "contract_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
}