Documentation Reference gRPC API reference gRPC: webhooks
Reference For: developers
gRPC: webhooks
Services, methods, messages and enums of webhooks.proto.
Webhook subscriptions: events are delivered as JSON (CloudEvents 1.0 envelope) with an HMAC-SHA256 signature, retried with backoff, and parked in a dead-letter list after the last attempt.
WebhookServiceWebhook subscriptions and their deliveries.
Messages
SubscriptionA webhook subscription.
Field Number Type Description id1 stringId of the subscription.
name2 stringName.
url3 stringHTTPS target the events are posted to.
event_types4 repeated string Event types to deliver (empty = all).
labels5 repeated string Free-form labels; alarms reference them in their actions.
enabled6 boolDeliveries are made.
max_attempts7 uint32Delivery attempts before an event becomes a dead letter.
dead_letters8 uint32Events that failed every attempt and are kept.
delivered9 uint64Events delivered.
failed10 uint64Delivery attempts that failed.
tenant11 stringTenant filter (tenant-N): only that tenant's self-service events.
CreateSubscriptionRequestCreates a subscription.
Field Number Type Description name1 stringName.
url2 stringHTTPS target.
secret3 stringShared secret for HMAC-SHA256; never returned.
event_types4 repeated string Event types to deliver; empty for all.
labels5 repeated string Labels of the subscription.
max_attempts6 uint32Delivery attempts before a dead letter; 0 for the default.
tenant7 stringDeliver only the self-service events of this tenant (tenant-N; empty: all).
ListSubscriptionsResponseThe subscriptions.
Field Number Type Description items1 repeated Subscription Every subscription the caller can see.
DeleteSubscriptionRequestDeletes a subscription.
Field Number Type Description id1 stringId of the subscription.
TestSubscriptionRequestSends a test event.
Field Number Type Description id1 stringId of the subscription.
DeliveryResultOutcome of a delivery.
Field Number Type Description delivered1 boolThe target accepted the event.
status2 uint32HTTP status the target answered; 0 without an answer.
error3 stringWhy the delivery failed; empty on success.
attempts4 uint32Attempts made.
DeadLetterAn event that failed every attempt.
Field Number Type Description event_id1 stringId of the event.
attempts2 uint32Attempts made.
last_error3 stringError of the last attempt.
failed_at4 stringTime of the last attempt, RFC 3339.
ListDeadLettersRequestLists the dead letters of a subscription.
Field Number Type Description id1 stringId of the subscription.
ListDeadLettersResponseThe dead letters.
Field Number Type Description items1 repeated DeadLetter Dead letters of the subscription.
Guides
Previous gRPC: identity Next gRPC: metrics
Version 0.1.