API Reference

Rotate signing secret

Requires subscriptions:manage and owner access. Encrypts and replaces the webhook signing secret, records an audit decision, and never returns secret material.

POST/v1/subscriptions/{id}/secret

Requires subscriptions:manage and owner access. Encrypts and replaces the webhook signing secret, records an audit decision, and never returns secret material.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Subscription ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/subscriptions/string/secret" \  -H "Content-Type: application/json" \  -d '{    "secret": "replace-with-a-new-strong-shared-secret"  }'
{  "subscription": {    "active": true,    "createdAt": "string",    "events": [      "string"    ],    "health": "string",    "id": "string",    "kmsKeyId": "string",    "ownerPrincipalId": "string",    "url": "string"  }}

Redeliver event POST

Requires subscriptions:manage and owner access. Queues another delivery attempt for the selected subscription event and returns the pending attempt immediately.

Trigger onboard-domain POST

Onboards one primary domain through registration, certificate and routing setup, Google Maps whitelisting, and completion. The request schema trims and lowercases domain, applies certificate option defaults, and normalizes ticket IDs. Required permission: workflows:onboard-domain. A new request is accepted for asynchronous Workflow SDK execution; use the returned execution ID with GET /v1/executions/{id} to track it.