Create User Webhook

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

CreateUserWebhook creates a new webhook for a user.

Parameters

Request body

Required

application/json · UserWebhook

Responses

Complete operation definition

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

{
  "tags": [
    "UserService"
  ],
  "description": "CreateUserWebhook creates a new webhook for a user.",
  "operationId": "UserService_CreateUserWebhook",
  "parameters": [
    {
      "name": "user",
      "in": "path",
      "description": "The user id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "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"
          }
        }
      }
    }
  }
}