Availability and Rates APIs
Booking APIs
Property Mgmt APIs
Notifications
ReferenceNotifications

refreshNotificationCallbackConfigSecret mutation

Refreshes the secret of the API key used by the callback configuration.

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. Note that if the secret expires, notifications fail to be sent for active subscriptions, though we attempt to retry sending them (according to the retry policy for the event type). If the secret is refreshed during these retry attempts, notifications will be sent successfully.

Syntax

1mutation { 
2  refreshNotificationCallbackConfigSecret(
3    input: RefreshNotificationCallbackConfigSecretInput!
4  ): RefreshNotificationCallbackConfigSecretPayload
5}

Example

1mutation {
2  refreshNotificationCallbackConfigSecret (
3    input: {
4      callbackConfigId: "1969081f-8380-4dbd-9a19-c26fc1747b06"
5    })
6  {
7    callbackConfigId
8      secret
9      secretExpirationDateTime
10    }
11  }
12}

Arguments

NameDescription

input

Required.

Callback configuration to update.

Type: RefreshNotificationCallbackConfigSecretInput

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.

LocalDateTime
LocalDateTime

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

RefreshNotificationCallbackConfigSecretInput
InputObject

Callback configuration to update.

FieldDescription
callbackConfigIdNot nullable.

ID of callback configuration to update.

Type: ID
RefreshNotificationCallbackConfigSecretPayload
Object

Details to use when updating the callback configuration's secret.

FieldDescription
callbackConfigIdNot nullable.

ID of callback configuration whose secret is updated.

Type: ID
secretNot nullable.

Secret string.

Type: String
secretExpirationDateTimeNot nullable.

Expiration date and time of 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.