Webhook Subscriptions API

You are viewing an old version of the API

2023-01-19

Version 2023-01-19

• All Versions

Webhook Subscriptions API

Update webhook subscription signature key BETA

Path Parameters

Example code

Name	Description
subscription_id string Required	[REQUIRED] The ID of the Subscription to update.

Request Body

Name	Description
idempotency_key string	A unique string that identifies the UpdateWebhookSubscriptionSignatureKey request. Max Length 45

Response Fields

Name	Description
errors Error [ ]	Information on errors encountered during the request. Show Attributes
signature_key string	Read only The new Square-generated signature key used to validate the origin of the webhook event.

curl https://connect.squareup.com/v2/webhooks/subscriptions/subscription_id0/signature-key \
  -X POST \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "ed80ae6b-0654-473b-bbab-a39aee89a60d"
  }'

{
  "signature_key": "1k9bIJKCeTmSQwyagtNRLg"
}