Rotate a webhook subscription's signing secret

POST

/api/v1/webhooks/{id}/rotate-secret

const url = 'https://api-omni.linra.net/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api-omni.linra.net/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret \
  --header 'Authorization: Bearer <token>'

The NEW secret is shown exactly once in this response. The old secret stops verifying immediately.

Authorizations

partnerBearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

The new secret.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

subscriptionId

string format: uuid

secret

The NEW secret, shown exactly once.

string

Example

{
  "state": "SUCCESS"
}

404

Unknown subscription.

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

429

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.