Rotate Secret Key - PassEntry

PATCH

api

webhook-subscriptions

{id}

rotate-secret

Rotate Secret Key

curl --request PATCH \
  --url https://api.passentry.com/api/v1/webhook-subscriptions/{id}/rotate-secret \
  --header 'Authorization: Bearer <token>'

{
  "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
  "type": "webhookSubscription",
  "attributes": {
    "url": "https://example.com/webhook",
    "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
    "enabled": true,
    "scopeName": "Test Organisation",
    "subscribedEvents": []
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Webhook subscription ID

Response

Secret key rotated successfully

string

Unique identifier for the webhook subscription

Example:

"01983282-53cf-7e16-b5e1-dd0de4ce02fa"

type

enum<string>

Type of the resource

Available options:

webhookSubscription

attributes

object

Show child attributes

Webhooks

⌘I

Rotate Secret Key

curl --request PATCH \
  --url https://api.passentry.com/api/v1/webhook-subscriptions/{id}/rotate-secret \
  --header 'Authorization: Bearer <token>'

{
  "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
  "type": "webhookSubscription",
  "attributes": {
    "url": "https://example.com/webhook",
    "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
    "enabled": true,
    "scopeName": "Test Organisation",
    "subscribedEvents": []
  }
}