Rotate the signing secret of a webhook target
POST
/api/v1/notification-targets/{id}/rotate-secret
const url = 'http://localhost:3000/api/v1/notification-targets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret';const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:3000/api/v1/notification-targets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret \ --header 'X-API-Key: <X-API-Key>'Generates a new HMAC-SHA256 signing secret on the server and returns it in THIS response only. The previous secret stops working immediately (FM-1660).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Header Parameters
Section titled “Header Parameters”x-organization-id
string format: uuid
UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.
Responses
Section titled “Responses”Media typeapplication/json
object
id
required
string format: uuid
secret
required
The new HMAC-SHA256 signing key. Shown once and never returned again; the previous key stops working immediately.
string
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "secret": "example"}The target is not a WEBHOOK target
No such target in the caller’s organization