UserWebhook

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• POSTCreate User Webhook/api/v1/users/{user}/webhooks
• PATCHUpdate User Webhook/api/v1/users/{user}/webhooks/{webhook}

Referenced by these component schemas:

• ListUserWebhooksResponse
• UserSetting_WebhooksSetting

Shape and fields

object

UserWebhook represents a webhook owned by a user.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the webhook.\n Format: users/{user}/webhooks/{webhook}"
    },
    "url": {
      "type": "string",
      "description": "The URL to send the webhook to."
    },
    "displayName": {
      "type": "string",
      "description": "Optional. Human-readable name for the webhook."
    },
    "createTime": {
      "readOnly": true,
      "type": "string",
      "description": "The creation time of the webhook.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "type": "string",
      "description": "The last update time of the webhook.",
      "format": "date-time"
    },
    "signingSecret": {
      "writeOnly": true,
      "type": "string",
      "description": "Optional. Signing secret used to HMAC-SHA256 sign the webhook request body.\n This field is input-only; it is never returned in responses."
    },
    "signingSecretSet": {
      "readOnly": true,
      "type": "boolean",
      "description": "Whether a signing secret is configured for this webhook."
    }
  },
  "description": "UserWebhook represents a webhook owned by a user."
}