> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.airweave.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.airweave.ai/_mcp/server. # Update Subscription PATCH https://api.airweave.ai/webhooks/subscriptions/{subscription_id} Content-Type: application/json 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. Reference: https://docs.airweave.ai/api-reference/webhooks/patch-subscription-webhooks-subscriptions-subscription-id-patch ## Authentication - `x-api-key` header (required) — API Key authentication via header ## Servers - `https://api.airweave.ai` (Production, default) - `http://localhost:8001` (Local) ## Request ### Path parameters - `subscription_id` (string, required) — The unique identifier of the subscription to update (UUID). ### Body (application/json) This endpoint expects a PatchSubscriptionRequest. - `url` (string, optional, nullable) — New URL for webhook delivery. Must be a publicly accessible HTTPS endpoint. - `event_types` (list of enum, optional, nullable) — New list of event types to subscribe to. This replaces the existing list entirely. - Allowed values: `sync.pending`, `sync.running`, `sync.cancelling`, `sync.completed`, `sync.failed`, `sync.cancelled`, `entity.batch_processed`, `query.processed`, `access_control.batch_processed`, `collection.created`, `collection.updated`, `collection.deleted`, `source_connection.created`, `source_connection.auth_completed`, `source_connection.deleted`, `organization.created`, `organization.deleted`, `organization.member_added`, `organization.member_removed`, `search.started`, `search.completed`, `search.failed`, `search.reranking`, `search.thinking`, `search.tool_called` - `disabled` (boolean, optional, nullable) — Set to `true` to pause delivery to this subscription, or `false` to resume. Disabled subscriptions will not receive events. - `recover_since` (string, optional, nullable) — When re-enabling a subscription (`disabled: false`), optionally recover failed messages from this timestamp. Only applies when enabling. ## Response ### 200 Updated subscription - `id` (string, required) — Unique identifier for this subscription (UUID format) - `url` (string, required) — The URL where webhook events are delivered - `created_at` (string, required) — When this subscription was created (ISO 8601 format, UTC) - `updated_at` (string, required) — When this subscription was last updated (ISO 8601 format, UTC) - `filter_types` (list of string, optional, nullable) — Event types this subscription is filtered to receive. See EventType enum for all available types. - `disabled` (boolean, optional, default: false) — Whether this subscription is currently disabled. Disabled subscriptions do not receive event deliveries. - `description` (string, optional, nullable) — Optional human-readable description of this subscription - `health_status` (enum, optional) — 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: `healthy`, `degraded`, `failing`, `unknown` ## Errors ### 404 Not Found Error Subscription Not Found - `detail` (string, required) — Error message describing what was not found ### 422 Unprocessable Entity Error Validation Error - `detail` (list of ValidationErrorDetail, required) — List of validation errors ### 429 Too Many Requests Error Rate Limit Exceeded - `detail` (string, required) — Error message explaining the rate limit ## Types ### ValidationErrorDetail Details about a validation error for a specific field. - `loc` (list of string, required) — Location of the error (e.g., ['body', 'url']) - `msg` (string, required) — Human-readable error message - `type` (string, required) — Error type identifier ## Examples **Request** ```json { "summary": "Update event types", "value": { "event_types": [ "sync.completed", "sync.failed", "sync.running" ] } } ``` **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" } ``` **SDK Code** ```python 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": "", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```typescript import { AirweaveSDKClient } from "@airweave/sdk"; const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" }); await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000"); ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000" payload := strings.NewReader("{\n \"summary\": \"Update event types\",\n \"value\": {\n \"event_types\": [\n \"sync.completed\",\n \"sync.failed\",\n \"sync.running\"\n ]\n }\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("x-api-key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["x-api-key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"summary\": \"Update event types\",\n \"value\": {\n \"event_types\": [\n \"sync.completed\",\n \"sync.failed\",\n \"sync.running\"\n ]\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000") .header("x-api-key", "") .header("Content-Type", "application/json") .body("{\n \"summary\": \"Update event types\",\n \"value\": {\n \"event_types\": [\n \"sync.completed\",\n \"sync.failed\",\n \"sync.running\"\n ]\n }\n}") .asString(); ``` ```php request('PATCH', 'https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000', [ 'body' => '{ "summary": "Update event types", "value": { "event_types": [ "sync.completed", "sync.failed", "sync.running" ] } }', 'headers' => [ 'Content-Type' => 'application/json', 'x-api-key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000"); var request = new RestRequest(Method.PATCH); request.AddHeader("x-api-key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"summary\": \"Update event types\",\n \"value\": {\n \"event_types\": [\n \"sync.completed\",\n \"sync.failed\",\n \"sync.running\"\n ]\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "x-api-key": "", "Content-Type": "application/json" ] let parameters = [ "summary": "Update event types", "value": ["event_types": ["sync.completed", "sync.failed", "sync.running"]] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.airweave.ai/webhooks/subscriptions/550e8400-e29b-41d4-a716-446655440000")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```