Rotate a webhook signing secret

POST

/api/v1/organizations/{organizationId}/webhooks/{webhookId}/rotate-secret

curl --request POST \
  --url https://api.koneth.com/api/v1/organizations/b7378db4-5a7a-4e69-a8df-04f2e6d94243/webhooks/0f6f2d88-9357-4ce6-9b9e-76db2f98bb2e/rotate-secret \
  --header 'Authorization: Bearer <token>'

• Production
• Local development

Issues a new signing secret. Deliveries fail signature checks until the receiver is updated, so rotate during a maintenance window.

Authorizations

• consoleSession

Parameters

Path Parameters

organizationId

required

string format: uuid

UUID of the organization the signed-in user belongs to.

Example

b7378db4-5a7a-4e69-a8df-04f2e6d94243

webhookId

required

string format: uuid

UUID of a webhook endpoint in the organization.

Example

0f6f2d88-9357-4ce6-9b9e-76db2f98bb2e

Responses

200

New signing secret. It is not returned again.

Media typeapplication/json

object

endpoint

required

object

id

required

string format: uuid

secret

required

string

warning

string

Example^generated

{
  "endpoint": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "secret": "example",
    "warning": "example"
  }
}

401

The Console session is missing or expired.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Authentication required"
}

403

The signed-in user is not an organization Owner or Finance member.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Insufficient organization permission"
}

404

The requested resource was not found.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example^generated

{
  "error": "example",
  "issues": [
    {}
  ]
}

500

Unexpected server error.

Media typeapplication/json

object

error

required

string

issues

Validation issue details when the request fails schema validation.

Array<object>

object

key

additional properties

any

Example

{
  "error": "Internal server error"
}