Class Webhook
- Namespace
- GenerativeAI.Types
- Assembly
- GenerativeAI.dll
A Webhook resource: an endpoint that receives event notifications (for example when a batch job or a background interaction finishes). The Webhooks API uses snake_case field names on the wire.
public class Webhook
- Inheritance
-
Webhook
- Inherited Members
- Extension Methods
Properties
CreateTime
Output only. The timestamp (RFC 3339) when the webhook was created.
[JsonPropertyName("create_time")]
public string? CreateTime { get; set; }
Property Value
Id
Output only. The ID of the webhook.
[JsonPropertyName("id")]
public string? Id { get; set; }
Property Value
Name
Optional. The user-provided name of the webhook.
[JsonPropertyName("name")]
public string? Name { get; set; }
Property Value
NewSigningSecret
Output only. The new signing secret for the webhook. Only populated in the response of a create call; store it to verify the payloads delivered to Uri.
[JsonPropertyName("new_signing_secret")]
public string? NewSigningSecret { get; set; }
Property Value
SigningSecrets
Output only. The signing secrets associated with this webhook.
[JsonPropertyName("signing_secrets")]
public List<SigningSecret>? SigningSecrets { get; set; }
Property Value
State
Output only. The state of the webhook (see WebhookStates).
[JsonPropertyName("state")]
public string? State { get; set; }
Property Value
SubscribedEvents
Required. The events that the webhook is subscribed to (see WebhookEvents).
[JsonPropertyName("subscribed_events")]
public List<string>? SubscribedEvents { get; set; }
Property Value
UpdateTime
Output only. The timestamp (RFC 3339) when the webhook was last updated.
[JsonPropertyName("update_time")]
public string? UpdateTime { get; set; }
Property Value
Uri
Required. The URI to which webhook events will be sent.
[JsonPropertyName("uri")]
public string? Uri { get; set; }