Skip to main content

webhooksRotateSecret

Replaces the signing secret for a rule's webhook deliveries.

Business Rules​

  • The rule must belong to the current company and have a Send Webhook action.
  • The previous secret stops verifying immediately. Reveal the new secret and update the receiver right away; deliveries in the gap retry for roughly ten minutes.

Error Scenarios​

  • Returns a not found error when the rule does not exist in the current company.
  • Returns a validation error when the rule has no Send Webhook action.

Permissions Required​

  • webhooks:rotate_secret
webhooksRotateSecret(
  input: RotateWebhookSecretInput!
): Automation!

Arguments​

webhooksRotateSecret.input ● RotateWebhookSecretInput! non-null input common​

Parameters for RotateWebhookSecret

Type​

Automation object automations​

The automation rule type