Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-222763184.3 KB
webhooks

Update Subscription

Update an existing webhook subscription.

Use this endpoint to modify a subscription's configuration. You can:

  • Change the URL: Update where events are delivered
  • Update event types: Modify which events trigger notifications
  • Enable/disable: Temporarily pause delivery without deleting the subscription
  • Recover messages: When re-enabling, optionally recover missed messages

Only include the fields you want to change. Omitted fields will retain their current values.

When re-enabling a subscription (disabled: false), you can optionally provide recover_since to automatically retry all messages that were generated while the subscription was disabled.

patch/webhooks/subscriptions/{subscription_id}

Path parameters

subscription_idstring required

The unique identifier of the subscription to update (UUID).

Example:550e8400-e29b-41d4-a716-446655440000

The unique identifier of the subscription to update (UUID).

Request body

urlstring uri nullable

New URL for webhook delivery. Must be a publicly accessible HTTPS endpoint.

event_typesEventType[] nullable

New list of event types to subscribe to. This replaces the existing list entirely.

disabledboolean nullable

Set to true to pause delivery to this subscription, or false to resume. Disabled subscriptions will not receive events.

recover_sincestring date-time nullable

When re-enabling a subscription (disabled: false), optionally recover failed messages from this timestamp. Only applies when enabling.

Example request

{
  "summary": "Update event types",
  "value": {
    "event_types": [
      "sync.completed",
      "sync.failed",
      "sync.running"
    ]
  }
}

Response

Updated subscription

idstring required

Unique identifier for this subscription (UUID format)

urlstring required

The URL where webhook events are delivered

filter_typesstring[] nullable

Event types this subscription is filtered to receive. See EventType enum for all available types.

disabledboolean

Whether this subscription is currently disabled. Disabled subscriptions do not receive event deliveries.

descriptionstring nullable

Optional human-readable description of this subscription

created_atstring date-time required

When this subscription was created (ISO 8601 format, UTC)

updated_atstring date-time required

When this subscription was last updated (ISO 8601 format, UTC)

health_status'healthy' | 'degraded' | 'failing' | 'unknown'

Health status of a webhook subscription based on recent delivery attempts.

Example response

{
  "created_at": "2024-03-01T08:00:00Z",
  "description": "Production notifications for data team",
  "disabled": false,
  "filter_types": [
    "sync.completed",
    "sync.failed"
  ],
  "health_status": "healthy",
  "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "updated_at": "2024-03-15T14:30:00Z",
  "url": "https://api.mycompany.com/webhooks/airweave"
}