Rotate webhook secret

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

Generate a fresh webhook secret for the organization, replacing any existing one. The plaintext secret is returned in the response and is never shown again, so store it before you close the connection. It's used to sign outbound webhook payloads, and your receiver verifies them with the same value.

Request

Path Parameters

orgId stringrequired
Organization ID
Example: 507f1f77bcf86cd799439011

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...