Update Subscription

import requests
url = "https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000"
payload = {
    "summary": "Update event types",
    "value": { "event_types": ["sync.completed", "sync.failed", "sync.running"] }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

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

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.

import requests
url = "https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000"
payload = {
    "summary": "Update event types",
    "value": { "event_types": ["sync.completed", "sync.failed", "sync.running"] }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

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

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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

subscription_idstringRequired

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

Request

This endpoint expects an object.

urlstring or nullOptionalformat: "uri"1-2083 characters

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

event_typeslist of enums or nullOptional

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

disabledboolean or nullOptional

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

recover_sincestring or nullOptionalformat: "date-time"

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

Response

Updated subscription

idstring

Unique identifier for this subscription (UUID format)

urlstring

The URL where webhook events are delivered

created_atstringformat: "date-time"

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

updated_atstringformat: "date-time"

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

filter_typeslist of strings or null

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

disabledbooleanDefaults to false

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

descriptionstring or null

Optional human-readable description of this subscription

health_statusenum

Health status of this subscription based on recent delivery attempts. Values: ‘healthy’ (all recent deliveries succeeded), ‘degraded’ (mix of successes and failures), ‘failing’ (consecutive failures beyond threshold), ‘unknown’ (no delivery data yet).

Allowed values:

Errors

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

1	import requests
2
3	url = "https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000"
4
5	payload = {
6	"summary": "Update event types",
7	"value": { "event_types": ["sync.completed", "sync.failed", "sync.running"] }
8	}
9	headers = {
10	"x-api-key": "<apiKey>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.patch(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
3	"url": "https://api.mycompany.com/webhooks/airweave",
4	"created_at": "2024-03-01T08:00:00Z",
5	"updated_at": "2024-03-15T14:30:00Z",
6	"filter_types": [
7	"sync.completed",
8	"sync.failed"
9	],
10	"disabled": false,
11	"description": "Production notifications for data team",
12	"health_status": "healthy"
13	}