Rust · 0.1.0

Update User Webhook

PATCH /api/v1/users/{user}/webhooks/{webhook}

UserService · UserService_UpdateUserWebhook

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.

Destination and signing behavior

The destination must satisfy the instance's outbound-network policy. Creation generates a signing secret when none is supplied, but does not return it; retrieve it only through GetUserWebhookSigningSecret. List/create/update responses expose signingSecretSet instead of the secret. Update masks use url, display_name and signing_secret. Confirm receiver ownership and data handling before enabling delivery, because payloads can include memo content.

Request

UpdateUserWebhook updates an existing webhook for a user.

PATCH/api/v1/users/{user}/webhooks/{webhook}

Parameters

Name / location	Type / requirement	Description
`user` path	string Required	The user id.
`webhook` path	string Required	The webhook id.
`updateMask` query	string (field-mask) Not marked required in OpenAPI	The list of fields to update.

Request body

Required

application/json · UserWebhook

Responses

200 · OK

application/json · UserWebhook

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": "UpdateUserWebhook updates an existing webhook for a user.",
  "operationId": "UserService_UpdateUserWebhook",
  "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"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "The list of fields to update.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/UserWebhook"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UserWebhook"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}