Skip to main content

Rotate a webhook secret

The existing secret will be invalidated immediately and subsequent webhook payloads will be accompanied by HMACs using the new secret.

Path Parameters
idstringrequired

The webhooks's unique identifier

Returns
idstringrequired

The webhook's unique identifier

urlstring^https:\/\/[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$required

An HTTPS URL

enabledbooleanrequired

Determines if events should be sent to the webhook or not.

account_typeenumrequired

The account's type.

Enum:
  • live
  • test
account_idsarray of string

The webhook will exclusively push events which belong to account identifiers.

Acts as a filter: if not set, events belonging to all the organisation's accounts are pushed.

created_atstringdate-timerequired

An <a href="https://pretty-rfc.herokuapp.com/RFC3339">RFC 3339</a>-formatted timestamp.

secretstringrequired

The secret key used to generate the webhook payload HMAC.

  • PUT /webhooks/{id}/rotate-secret
    • curl 'https://api.lune.co/v1/webhooks/ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz/rotate-secret' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -X PUT
  • Response
    • {
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "url": "https://lune.co",
  "enabled": true,
  "account_type": "live",
  "account_ids": [
    "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz"
  ],
  "created_at": "1985-04-12T23:20:50.52Z",
  "secret": "secret"
}