Sift | Docs
APIReferenceREST (HTTP/JSON)Webhook service

ToggleWebhookSignatureKeyActivation

Set the activation state of the organization's current webhook signature key. Will return a not found error if one doesn't yet exist.

PATCH
/api/v1/webhooks/signature-key

Request Body

application/jsonRequired

The request for a call to WebhookService_ToggleWebhookSignatureKeyActivation to enable or disable the current webhook signature key. Set enable to true to activate the signature key, and false to deactivate.

enable
Required
boolean

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

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

TestWebhook POST

Next

UpdateWebhook PATCH