get_subscription

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Health

Webhook Subscriptions

Monitor Tokens

Developer Account

Faucet

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

get_subscriptionPython,latest

Go to PyPI

Retrieve an existing notification subscription.

Parameters

string

Required

The universally unique identifier of the resource.

x_request_id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Responses

200SubscriptionResponse

Response Body

object

data

object

Contains information about a webhook notification subscription.

Show 8 properties

string

Required

System-generated unique identifier of the resource.

name

string

Required

Name of the webhook notification subscription.

endpoint

string

Required

URL of the endpoint subscribing to notifications. Must be enabled to receive notifications.

enabled

boolean

Required

Whether the subscription is enabled. true indicates the subscription is enabled.

create_date

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

update_date

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

notification_types

array of strings

The notification types on which a notification will be sent.

Allowed values*transactions.*transactions.inboundtransactions.outboundchallenges.*challenges.accelerateTransactionchallenges.cancelTransactionchallenges.changePinchallenges.contractExecutionchallenges.createTransactionchallenges.createWalletchallenges.initializechallenges.restorePinchallenges.setPinchallenges.setSecurityQuestionscontracts.*contracts.eventLogmodularWallet.*modularWallet.userOperationmodularWallet.inboundTransfermodularWallet.outboundTransfertravelRule.*travelRule.statusUpdatetravelRule.denytravelRule.approverampSession.*rampSession.completedrampSession.depositReceivedrampSession.expiredrampSession.failedrampSession.kycApprovedrampSession.kycRejectedrampSession.kycSubmitted

restricted

boolean

Whether the webhook is restricted to specific notification types. An unrestricted webhook will notify on all notification types. A restricted webhook will only notify on the notification types in the notificationTypes field.

401NotAuthorizedResponse

404NotFoundResponse

Example

1from circle.web3 import configurations
2from circle.web3 import utils
3
4client = utils.init_configurations_client(api_key=key)
5
6api_instance = utils.configurations.WebhookSubscriptionsApi(client)
7response = api_instance.get_subscription(id="d1b66f87-2320-5834-bcd3-175a36a4d331")
8print(response.json())
9

ResponseChoose an example

1{
2  "data": {
3    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4    "name": "Transactions Webhook",
5    "endpoint": "https://example.org/handler/for/notifications",
6    "enabled": true,
7    "create_date": "2023-01-01T12:04:05Z",
8    "update_date": "2023-01-01T12:04:05Z",
9    "notification_types": [
10      "*"
11    ],
12    "restricted": false
13  }
14}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy