Rust · 0.1.0

Get User Webhook Signing Secret

GET /api/v1/users/{user}/webhooks/{webhook}:getSigningSecret

UserService · UserService_GetUserWebhookSigningSecret

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Owner-only: the user named in the path must be the authenticated caller. Instance administrator status does not allow acting on another account here.

Sensitive read

Returns the stored signing secret through an explicit owner-only request. Use it in a receiver's secure configuration; avoid printing it in logs or including it in documentation examples. Ordinary webhook metadata responses cannot substitute for this call.

Request

GetUserWebhookSigningSecret returns the signing secret for a webhook. The secret is returned only through this explicit, owner-gated call; it is never included in List/Create/Update responses.

GET/api/v1/users/{user}/webhooks/{webhook}:getSigningSecret

Parameters

Name / location	Type / requirement	Description
`user` path	string Required	The user id.
`webhook` path	string Required	The webhook id.

Request body

No request body is declared.

Responses

200 · OK

application/json · GetUserWebhookSigningSecretResponse

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "tags": [
    "UserService"
  ],
  "description": "GetUserWebhookSigningSecret returns the signing secret for a webhook.\n The secret is returned only through this explicit, owner-gated call; it is\n never included in List/Create/Update responses.",
  "operationId": "UserService_GetUserWebhookSigningSecret",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "webhook",
      "in": "path",
      "description": "The webhook id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetUserWebhookSigningSecretResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}