Sift | Docs
APIReferenceREST (HTTP/JSON)Webhook service

ToggleWebhookSignatureKeyActivation

Generate a new webhook signature key and replace the previous one. The activation state of the new key will match the activation state of the previous.

PUT
/api/v1/webhooks/signature-key

Request Body

application/jsonRequired

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.

body
Required
object

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.

curl -X PUT "<API_URL>/api/v1/webhooks/signature-key" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

A successful response.

{
  "signatureKey": {
    "signatureKey": "string",
    "active": true,
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string"
  }
}

Previous

ListWebhooks GET

Next

TestWebhook POST