Webhooks

Get workspace webhook secret status

Returns the status of the workspace webhook secret including creation date, rotation date, and grace period status.

get/workspaces/{id}/webhooks/secret-status

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/workspaces/:id/webhooks/secret-status/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Workspace ID

Secret status retrieved

created_atstring date-time nullable required

When the webhook secret was created

last_rotated_atstring date-time nullable

When the webhook secret was last rotated

grace_period_activeboolean

Whether the old secret is still valid alongside the new one

grace_period_ends_atstring date-time nullable

When the old secret grace period expires

No recorded changes to this operation across all 13 revisions of this API.