Availability and Rates APIs
Booking APIs
Property Mgmt APIs
Notifications
ReferenceNotifications

createNotificationCallbackConfig mutation

Creates the callback configuration for the lodging partner account, including the callback URL (where notification events are sent when they occur), API key, partner email address (where secret expiry warnings are sent), and request timeout value. If the partner's notification profile does not exist, this mutation will create the profile, too.

Syntax

1mutation { 
2  createNotificationCallbackConfig(
3    input: CreateNotificationCallbackConfigInput!
4  ): CreateNotificationCallbackConfigPayload
5}

Example

1mutation {
2  createNotificationCallbackConfig (
3    input: {
4      callbackUrl : "https://testcallbackurl.com",
5      apiKey : "newapikey",
6      requestTimeoutSeconds: 50,
7      contactEmail: "partner@email.com"
8    }
9  ) {
10    callbackConfig {
11      id
12      callbackUrl
13      secretExpirationDateTime
14      requestTimeoutSeconds
15      contactEmail
16    }
17    secret
18  }
19}

Arguments

NameDescription

input

Required.

Details used when creating the callback configuration.

Type: CreateNotificationCallbackConfigInput

Types


Name
Type
CreateNotificationCallbackConfigInput
InputObject

Details about the callback configuration.

FieldDescription
apiKeyNot nullable.

Key used to authenticate requests.

Type: String
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
requestTimeoutSeconds

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. Specify values between 1-60; default value is 60.

Type: Int
CreateNotificationCallbackConfigPayload
Object

Details about the callback configuration returned by the mutation.

FieldDescription
callbackConfigNot nullable.

Details about the callback configuration.

Type: NotificationCallbackConfig
secretNot nullable.

String used to validate the signature of payloads when you receive notifications from the webhooks service. By default, the secret is valid for one year (no notification is sent when the secret expires; you can determine when it will expire using the secretExpirationDateTime field).

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

Url
Url

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