USusememos
UserService

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

Changed on

UpdateUserWebhook updates a webhook. Only the owner may call it.

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

userstring required

The user id.

webhookstring required

The webhook id.

Query parameters

updateMaskstring field-mask

The fields to update. Supported paths: url, display_name, signing_secret. When unset, all of them are updated, skipping an empty url or signing_secret.

Request body

namestring

Identifier. The resource name of the webhook. Format: users/{user}/webhooks/{webhook}

displayNamestring

A human-readable name for the webhook.

urlstring

The URL the webhook request is sent to. Required on create.

signingSecretstring

Input only. The secret used to HMAC-SHA256 sign the webhook request body. Never returned; use GetUserWebhookSigningSecret to read it.

signingSecretSetboolean

Output only. Whether a signing secret is configured for this webhook.

createTimestring date-time

Output only. The creation timestamp. Currently never set.

updateTimestring date-time

Output only. The last update timestamp. Currently never set.

Response

OK

namestring

Identifier. The resource name of the webhook. Format: users/{user}/webhooks/{webhook}

displayNamestring

A human-readable name for the webhook.

urlstring

The URL the webhook request is sent to. Required on create.

signingSecretstring

Input only. The secret used to HMAC-SHA256 sign the webhook request body. Never returned; use GetUserWebhookSigningSecret to read it.

signingSecretSetboolean

Output only. Whether a signing secret is configured for this webhook.

createTimestring date-time

Output only. The creation timestamp. Currently never set.

updateTimestring date-time

Output only. The last update timestamp. Currently never set.

Changes