ReferenceNotifications

notificationProfile query

Retrieves the partner's notification profile and its subscriptions.

Syntax

1query {
2 notificationProfile {
3 subscriptions: [NotificationSubscription!]!
4 callbackConfigs: [NotificationCallbackConfig!]!
5 }
6}

Example

This returns the partner's callback configuration and event types to which the partner has subscribed. Note that if a profile has not been created for the partner or if the partner has not subscribed to event types, empty arrays are returned.

1query {
2 notificationProfile {
3 callbackConfigs {
4 id
5 callbackUrl
6 requestTimeoutSeconds
7 secretExpirationDateTime
8 }
9 subscriptions{
10 product
11 eventTypeSubscriptions {
12 eventType
13 callbackConfig {
14 id
15 }
16 }
17 }
18 }
19}

Arguments

NameDescription

Types


Name
Type
ID
ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int
Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

LocalDateTime
LocalDateTime

A type representing a date and time (such as 2007-12-03T10:15:30).

NotificationCallbackConfig
Object

Details about the callback configuration.

FieldDescription
callbackUrlNot nullable.

Callback URL (REST endpoint) where real-time events are sent.

Type: Url
idNot nullable.

ID of the callback configuration.

Type: ID
requestTimeoutSecondsNot nullable.

Amount of time (in seconds) we wait for the partner to respond when a notification is sent to them. If a response is not received within request timeout time, the notification is retried according to the retry policy.

Type: Int
secretExpirationDateTimeNot nullable.

Expiration date and time for the secret.

Type: LocalDateTime
NotificationEventTypeSubscription
Object

Callback URL and the event types to which it is subscribed.

FieldDescription
callbackConfigNot nullable.

Callback configuration information for the event type subscription.

Type: NotificationCallbackConfig
eventTypeNot nullable.

Name of the event type.

Type: String
NotificationProfile
Object

Callback configurations that exist for the notification profile.

FieldDescription
callbackConfigsNot nullable.

Details about the callback configurations of notification profile.

Type: Array of non nullable NotificationCallbackConfig
subscriptionsNot nullable.

Event type subscriptions of notification profile.

Type: Array of non nullable NotificationSubscription
NotificationSubscription
Object

Details about the event type subscription.

FieldDescription
eventTypeSubscriptionsNot nullable.

List of event type subscriptions.

Type: Array of non nullable NotificationEventTypeSubscription
productNot nullable.

Product name for the subscription.

Type: String
String
String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Url
Url

Scalar type whose value conforms to the standard URL format as specified in RFC3986 specification.