refreshNotificationCallbackConfigSecret mutation
Refreshes the secret of the API key used by the callback configuration. After the secret is refreshed, the new secret must be used to validate notifications immediately after a refresh is performed.
By default, the secret is valid for one year (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(5}
Example
- Request
- Response
1mutation {2 refreshNotificationCallbackConfigSecret (3 input: {4 callbackConfigId: "1969081f-8380-4dbd-9a19-c26fc1747b06"5 })6 {7 callbackConfigId8 secret9 secretExpirationDateTime10 }11 }12}
Arguments
Name | Description |
---|---|
| Required. Callback configuration to update. Type: RefreshNotificationCallbackConfigSecretInput |
Types
Name | Type | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
ID | ID | |||||||||
The | ||||||||||
LocalDateTime | LocalDateTime | |||||||||
A type representing a date and time (such as 2007-12-03T10:15:30). | ||||||||||
RefreshNotificationCallbackConfigSecretInput | InputObject | |||||||||
Callback configuration to update.
| ||||||||||
RefreshNotificationCallbackConfigSecretPayload | Object | |||||||||
Details to use when updating the callback configuration's secret.
| ||||||||||
String | String | |||||||||
The |