• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update webhook subscription signature key BETA

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

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

Name Description
subscription_id
string

Required

[REQUIRED] The ID of the Subscription to update.

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.

signature_key
string

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

Examples

You are viewing an old version of the API
POST /v2/webhooks/subscriptions/{subscription_id}/signature-key
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/webhooks/subscriptions/subscription_id0/signature-key \
  -X POST \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "ed80ae6b-0654-473b-bbab-a39aee89a60d"
  }'
Response JSON
{
  "signature_key": "1k9bIJKCeTmSQwyagtNRLg"
}