Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
WebhookSubscriptions

UpdateWebhookSubscriptionSignatureKey

Updates a webhook subscription by replacing the existing signature key with a new one.

post/v2/webhooks/subscriptions/{subscription_id}/signature-key

Path parameters

subscription_idstring required

[REQUIRED] The ID of the Subscription to update.

Request body

idempotency_keystring nullable

A unique string that identifies the UpdateWebhookSubscriptionSignatureKey request.

Example request

{
  "idempotency_key": "ed80ae6b-0654-473b-bbab-a39aee89a60d"
}

Response

Success

signature_keystring

The new Square-generated signature key used to validate the origin of the webhook event.

Example response

{
  "signature_key": "1k9bIJKCeTmSQwyagtNRLg"
}