getSubscription

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Developer Account

Initialization

Transactions

Monitored Tokens

Webhook Subscriptions

Wallets

Wallet Sets

Token Lookup

Faucet

Signing

getSubscriptionNode.js,latest

Go to NPM

Retrieve an existing notification subscription.

Parameters

subscriptionId

string

Required

Responses

SubscriptionResponse

Response Body

object

data

object

Contains information about a webhook notification subscription.

Show 8 properties

createDate

string

Required

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

enabled

boolean

Required

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

endpoint

string

Required

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

string

Required

System-generated unique identifier of the resource.

name

string

Required

Name of the webhook notification subscription.

notificationTypes

array of anys

The notification types on which a notification will be sent.

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.

updateDate

string

Required

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

Example

1const response = await client.getSubscription('b3d9d2d5-4c12-4946-a09d-953e82fae2b0')
2console.log(response)

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy