refreshNotificationCallbackConfigSecret mutationCopy link

Refreshes the secret of the API key used by the callback configuration. By default, a secret is valid for one year. No notification is sent when a secret expires; you can determine when it will expire using the secretExpirationDateTime field. If a 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 a secret is refreshed during these retry attempts, notifications will be sent successfully.

If the secret's expiry date is at least three days in the future, you can specify when the new secret is used by specifying the keepExistingSecretActive input parameter. The old and new secrets are sent in the x-eg-notification-signature-v2 notification header, in this format: sha256=hash(timestamp.notification_payload with newSecret),hash(timestamp.notification_payload with oldSecret) during this period.

Syntax

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

Example

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