Webhooks

Get webhook subscription

Changed on

Retrieve detailed information about a specific webhook subscription including configuration, status, creation timestamp, and webhook signature secret.

Response Includes

  • Subscription configuration and filters
  • Target URL and custom headers
  • Webhook signature secret for verification
  • Creation timestamp and status
get/v2/data/webhooks/subscriptions/{subscriptionId}

Request

  • Base URL: https://api.cdp.coinbase.com/platform
  • URL: https://api.cdp.coinbase.com/platform/v2/data/webhooks/subscriptions/{subscriptionId}
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring uuid required

Unique identifier for the webhook subscription.

Response

Webhook subscription details retrieved successfully.

createdAtstring date-time required

When the subscription was created.

updatedAtstring date-time

When the subscription was last updated.

descriptionstring

A human-readable description of the webhook subscription. Must be at most 100 characters.

eventTypesEventType[] 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").

isEnabledboolean required

Whether the subscription is enabled.

secretstring uuid required

Secret for webhook signature validation.

subscriptionIdstring uuid required

Unique identifier for the subscription.

labelsWebhookResponseLabels

Effective filters stored on the webhook subscription. The response includes client-supplied labels plus labels defaulted or injected by the server.

  • onchain.activity.detected, wallet.activity.detected, and wallet.activity.multi include network. It defaults to base-mainnet when omitted from the request.
  • wallet.activity.multi includes the requested comma-separated wallet_addresses.
  • health.* includes the requested service.
  • Project-scoped events include the authenticated project.
  • Entity-scoped events include the authenticated entity.
  • User-scoped events include the authenticated user_uuid and a sandbox value.

Example response

{
  "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"
  }
}

Changes

    • warning

      added the new acceptance.mandate.approval_failed enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.approval_initiated enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.approval_succeeded enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.canceled enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.created enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.revocation_failed enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.revocation_initiated enum value to the / response property for the response status

    • warning

      added the new acceptance.mandate.revocation_succeeded enum value to the / response property for the response status

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • info

      added 'else' subschema to the response body for the status

    • info

      added 'if' subschema to the response body for the status

    • info

      added 'then' subschema to the response body for the status