Get webhook subscription
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
Authorizations
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
Unique identifier for the webhook subscription.
^[a-f0-9\-]{36}$Response
Webhook subscription details retrieved successfully.
Response containing webhook subscription details.
When the subscription was created.
"2025-01-15T10:30:00Z"
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").
onchain.activity.detected, wallet.activity.detected, wallet.activity.multi, wallet.transaction.created, wallet.transaction.signed, wallet.transaction.broadcast, wallet.transaction.replaced, wallet.transaction.pending, wallet.transaction.confirmed, wallet.transaction.failed, wallet.delegation.created, wallet.delegation.revoked, wallet.typed_data.signed, wallet.message.signed, wallet.hash.signed, 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, onramp.transaction.created, onramp.transaction.updated, onramp.transaction.success, onramp.transaction.failed, offramp.transaction.created, offramp.transaction.updated, offramp.transaction.success, offramp.transaction.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, health.status.updated, health.maintenance.scheduled, health.maintenance.started, health.maintenance.completed, health.maintenance.canceled, customers.capability.changed, customers.customer.deleted Whether the subscription is enabled.
true
Secret for webhook signature validation.
"123e4567-e89b-12d3-a456-426614174000"
Unique identifier for the subscription.
"123e4567-e89b-12d3-a456-426614174000"
Target configuration for webhook delivery. Specifies the destination URL and any custom headers to include in webhook requests.
When the subscription was last updated.
"2025-01-16T14:00:00Z"
A human-readable description of the webhook subscription. Must be at most 100 characters.
100"Subscription for token transfer events"
Additional metadata for the subscription.
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, andwallet.activity.multiincludenetwork. It defaults tobase-mainnetwhen omitted from the request.wallet.activity.multiincludes the requested comma-separatedwallet_addresses.health.*includes the requestedservice.- Project-scoped events include the authenticated
project. - Entity-scoped events include the authenticated
entity. - User-scoped events include the authenticated
user_uuidand asandboxvalue.