Updates the callback configuration, including the callback URL, API key, partner email address (where secret expiry warnings are sent) and request timeout value.
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.
Field
Description
callbackUrl
Not nullable.
Callback URL (REST endpoint) where real-time events are sent.
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.
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.
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.
UpdateNotificationCallbackConfigInput
InputObject
Details to use when updating the callback configuration.
Field
Description
apiKey
Updated key used to authenticate requests. The key is a UTF-8 encoded string (no size limit).
Email address where a notification is sent when the callback configuration's
secret is about to expire. We recommend specifying an email distribution list
instead of an individual's address because addresses can become obsolete,
increasing the risk of expiry secrets not being reset in time. The email
notification is sent 30 days, 7 days, and 1 days prior to expiration.
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-10. We recommend that the partner responds in less
than five seconds, though less than one second is ideal. If this argument is
not set, the default is three seconds (though this field will still show null).
updateNotificationCallbackConfig mutation