Availability and Rates APIs
Booking APIs
Property Mgmt APIs
Notifications
ReferenceNotifications

subscribeNotificationEventType mutation

Subscribes a callback configuration to a notification event type. Each event type can be subscribed to one configuration only.

Syntax

1mutation { 
2  subscribeNotificationEventType(
3    input: SubscribeNotificationEventTypeInput!
4  ): SubscribeNotificationEventTypePayload
5}

Example

1mutation {     
2  subscribeNotificationEventType (
3    input: {
4     eventType: "GuestReviewSubmitted",
5      callbackConfigId: "1969081f-8380-4dbd-9a19-c26fc1747b06"
6    })  
7  {         
8    eventType
9    callbackConfig {
10      id
11      callbackUrl
12      requestTimeoutSeconds
13      secretExpirationDateTime
14      contactEmail
15    }             
16  }
17}

Arguments

NameDescription

input

Required.

Event types and callback configuration ID.

Type: SubscribeNotificationEventTypeInput

Types


Name
Type
EmailAddress
EmailAddress

A field whose value conforms to the standard internet email address format as specified in HTML Spec.

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
contactEmail

Email address where a notification is sent when the callback configuration's secret is about to expire. The email notification is sent 30 days, 7 days, and 1 days prior to expiration.

Type: EmailAddress
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
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.

SubscribeNotificationEventTypeInput
InputObject

Notification event type(s) and callback configuration to which they are subscribed.

FieldDescription
callbackConfigIdNot nullable.

ID of callback configuration to subscribe event types to.

Type: ID
eventTypeNot nullable.

Event type name to subscribe to.

Type: String
SubscribeNotificationEventTypePayload
Object

Details about the subscription after it is updated.

FieldDescription
callbackConfigNot nullable.

Callback configuration information for the event type subscription.

Type: NotificationCallbackConfig
eventTypeNot nullable.

Name of the event type.

Type: String
Url
Url

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