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.

WebhookService

Webhook subscriptions and their deliveries.

MethodRequestResponseDescription
CreateSubscriptionCreateSubscriptionRequestSubscription

Creates a webhook subscription.

ListSubscriptionsEmptyListSubscriptionsResponse

The webhook subscriptions.

DeleteSubscriptionDeleteSubscriptionRequestEmpty

Deletes a subscription.

TestSubscriptionTestSubscriptionRequestDeliveryResult

Sends a synthetic event to the subscription and reports the outcome.

ListDeadLettersListDeadLettersRequestListDeadLettersResponse

Deliveries that failed (dead letters).

Messages

Subscription

A webhook subscription.

FieldNumberTypeDescription
id1string

Id of the subscription.

name2string

Name.

url3string

HTTPS target the events are posted to.

event_types4repeated string

Event types to deliver (empty = all).

labels5repeated string

Free-form labels; alarms reference them in their actions.

enabled6bool

Deliveries are made.

max_attempts7uint32

Delivery attempts before an event becomes a dead letter.

dead_letters8uint32

Events that failed every attempt and are kept.

delivered9uint64

Events delivered.

failed10uint64

Delivery attempts that failed.

tenant11string

Tenant filter (tenant-N): only that tenant's self-service events.

CreateSubscriptionRequest

Creates a subscription.

FieldNumberTypeDescription
name1string

Name.

url2string

HTTPS target.

secret3string

Shared secret for HMAC-SHA256; never returned.

event_types4repeated string

Event types to deliver; empty for all.

labels5repeated string

Labels of the subscription.

max_attempts6uint32

Delivery attempts before a dead letter; 0 for the default.

tenant7string

Deliver only the self-service events of this tenant (tenant-N; empty: all).

ListSubscriptionsResponse

The subscriptions.

FieldNumberTypeDescription
items1repeated Subscription

Every subscription the caller can see.

DeleteSubscriptionRequest

Deletes a subscription.

FieldNumberTypeDescription
id1string

Id of the subscription.

TestSubscriptionRequest

Sends a test event.

FieldNumberTypeDescription
id1string

Id of the subscription.

DeliveryResult

Outcome of a delivery.

FieldNumberTypeDescription
delivered1bool

The target accepted the event.

status2uint32

HTTP status the target answered; 0 without an answer.

error3string

Why the delivery failed; empty on success.

attempts4uint32

Attempts made.

DeadLetter

An event that failed every attempt.

FieldNumberTypeDescription
event_id1string

Id of the event.

attempts2uint32

Attempts made.

last_error3string

Error of the last attempt.

failed_at4string

Time of the last attempt, RFC 3339.

ListDeadLettersRequest

Lists the dead letters of a subscription.

FieldNumberTypeDescription
id1string

Id of the subscription.

ListDeadLettersResponse

The dead letters.

FieldNumberTypeDescription
items1repeated DeadLetter

Dead letters of the subscription.

Version 0.1.