Webhooks

Rotate secret

Generates a new signing secret for the webhook and returns it exactly once; the previous secret stops being used immediately.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/webhooks/{id}/rotate_secret

Request arguments

Name	Type	Source
id	Int32

Request body example

Other statuses: 401 (Unauthorized), 403 (Forbidden), 404 (NotFound), 429 (TooManyRequests)

Response body example

Name	Type	ReadOnly	Description
id	Int32		Id
label	String		Label
url	String		Url
event_types	String[]		Public event names this subscription listens to, e.g. "ticket.created"
secret	String	ReadOnly	Only returned on create and rotate_secret - store it, it cannot be retrieved again
custom_header_name	String		Custom header name
custom_header_value_set	Boolean	ReadOnly	Whether a custom header value is configured. The value itself is never returned
enabled	Boolean		Enabled
disabled_reason	String	ReadOnly	Why the subscription is disabled: "user" or "auto_failures" (empty when enabled)
consecutive_failure_count	Int32	ReadOnly	Consecutive failure count
last_success	DateTime (nullable)	ReadOnly	Last success
last_failure	DateTime (nullable)	ReadOnly	Last failure
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Generated Aug 31, 2026 16:21