Skip to main content
PUT
/
api
/
v1
/
webhooks
/
signature-key
ToggleWebhookSignatureKeyActivation
curl --request PUT \
  --url https://your-sift-api-url.com/api/v1/webhooks/signature-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "signatureKey": {
    "signatureKey": "<string>",
    "active": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to WebhookService_RotateWebhookSignatureKey replace the current webhook signature key with a new one. The activation state of the new signature key will be inherited from the previous key. If no key exists then this will return an error - see WebhookService_CreateWebhookSignatureKey.

The request for a call to WebhookService_RotateWebhookSignatureKey replace the current webhook signature key with a new one. The activation state of the new signature key will be inherited from the previous key. If no key exists then this will return an error - see WebhookService_CreateWebhookSignatureKey.

Response

A successful response.

The response for a call to WebhookService_RotateWebhookSignatureKey. The active field indicates whether or not whether the key is currently active.

​
signatureKey
object
required