Rotate a webhook subscription's signing secret

POST

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

const url = 'https://api-omni.linra.net/api/v1/vendor/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/vendor/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret \
  --header 'Authorization: Bearer <token>'

Generates a new server-side signing secret and returns it in THIS response ONLY — the previous secret stops verifying signatures immediately. Requires the Orders capability.

Authorizations

vendorBearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

The new secret (shown once).

application/json

object

state

required

string

payload

required

details

object

payload

required

object

subscriptionId

string format: uuid

secret

Shown EXACTLY ONCE.

string

Example

{
  "state": "SUCCESS"
}

403

Your token doesn’t carry the capability this endpoint requires.

application/json

object

state

required

string

payload

details

object

Examples

missingCapability

{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

404

Unknown subscription id.

application/json

object

state

required

string

payload

details

object

Examples

notFound

{
  "state": "NOT_FOUND_VENDOR_WEBHOOK_SUBSCRIPTION",
  "payload": null,
  "details": {}
}

429

Too many requests. Retry after the Retry-After header (seconds).

application/json

object

state

required

string

payload

details

object

Example

{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Retry-After

integer

Seconds to wait before retrying.