bird webhooks update

Usage

Contoh kode

bird webhooks update <webhook-id> [flags]

Change an endpoint's URL, description, subscribed event types, or delivery status. Only the fields sent change: events replaces the whole subscription set, and status pauses or re-enables delivery. Events fired while paused are not delivered.

Build the request from flags, a JSON WebhookEndpointUpdate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Contoh kode

# print the body shape (no credentials needed)
bird webhooks update --example

# the body it prints:

Contoh kode

{
  "description": "Updated webhook endpoint",
  "events": ["email.delivered", "email.bounced", "email.complained"],
  "status": "active",
  "url": "https://example.com/webhook"
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--url	Replacement delivery URL. Same rules as at creation: HTTPS, at most 2048 characters, and the host must be publicly reachable (private, loopback, and link-local addresses return a 422). Omit to keep the current URL.
--description	Human-readable label for this endpoint, up to 256 characters.
--events <v1,v2,…>	Replaces all event subscriptions with this list. Omit to keep the current set. Types outside the event catalog return a 422. Known values: domain.failed, domain.verified, email.accepted, email.bounced, email.canceled, email.clicked, email.complained, email.deferred, email.delivered, email.list_unsubscribed, email.opened, email.out_of_band_bounce, email.processed, email.received, email.rejected, email.scheduled, email.unsubscribed, email_mailbox.message_delivered, email_mailbox.message_failed, email_mailbox.message_received, email_mailbox.message_sent, email_mailbox.suspended, email_mailbox.thread_created, email_suppression.created, preference.deleted, preference.granted, preference.revoked, sms.accepted, sms.delivered, sms.expired, sms.failed, sms.received, sms.rejected, sms.sent, sms.undelivered, sms_suppression.created, verify.attempt.delivered, verify.attempt.sent, verify.attempt.undelivered, verify.verification.created, verify.verification.failed, verify.verification.verified, voice_call.answered, voice_call.ended, voice_call.initiated, whatsapp.accepted, whatsapp.delivered, whatsapp.failed, whatsapp.read, whatsapp.received, whatsapp.rejected, whatsapp.sent, whatsapp_suppression.created (others may exist).
--status	paused stops all deliveries; active re-enables a paused endpoint. Omit to leave the status unchanged. Events that fire while paused are not delivered; after re-enabling, recover them with Replay missed events. A degraded endpoint cannot be reset through this field: it returns to active automatically once deliveries succeed again. Possible values: active, paused.
--response-schema	Print the fields this command returns, then exit

Name	Description
bird webhooks attempts	List delivery attempts
bird webhooks create	Create a webhook endpoint
bird webhooks delete	Delete a webhook endpoint
bird webhooks get	Get a webhook endpoint
bird webhooks list	List webhook endpoints
bird webhooks rotate-secret	Rotate webhook signing secret
bird webhooks test	Test a webhook with a sample event