Generate or rotate the webhook secret

POST 
/v1/organizations/:orgId/webhook-secret

Generates a new webhook secret for the organization. If one already exists, it is replaced. Returns the plaintext secret (only time it is shown).

Request

Path Parameters

orgId stringrequired

Organization ID

Responses

200

Webhook secret generated successfully

application/json

Schema

Schema

secret string

The plaintext webhook secret (32 bytes encoded as 64-character lowercase hex)

Example (from schema)

{
  "secret": "3f4a8c1b2d6e9f0a7b5c8d1e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0"
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

403

Forbidden

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

404

Organization not found

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

429

Too Many Requests

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

Loading...