Sift | Docs

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

Request Body

application/jsonRequired

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

body
Required
object

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

curl -X POST "<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"
  }
}