CreateOrUpdateWebhookSignatureKey

Create a webhook signature key and set its activation state. If a webhook signature key is active, the bodies of all webhooks will be signed using the signature key with HMAC-SHA-256.The signature generated will then included in the X-Sift-Signature HTTP header. Only one key can be held per organization. If an existing key exists, then this will simply return it.See WebhookService_RotateWebhookSignatureKey to rotate the key.

POST /api/v1/webhooks/signature-key

CreateOrUpdateWebhookSignatureKey

cURL

curl --request POST \
  --url https://api.siftstack.com/api/v1/webhooks/signature-key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "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_CreateWebhookSignatureKey to create a webhook signature key.

The request for a call to WebhookService_CreateWebhookSignatureKey to create a webhook signature key.

Response

200

application/json

A successful response.

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

signatureKey · object · required

Show child attributes