AIairweave-ai
webhooks

Delete Subscription

Changed on

Permanently delete a webhook subscription.

Once deleted, Airweave will stop sending events to this endpoint immediately. This action cannot be undone. Any pending message deliveries will be cancelled.

If you want to temporarily stop receiving events, consider disabling the subscription instead using the PATCH endpoint.

delete/webhooks/subscriptions/{subscription_id}

Request

  • Base URL
    https://api.airweave.ai
  • Auth
    API key in header x-api-key

Path parameters

subscription_idstring required

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

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

Response

Deleted 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"
}

Changes

  • a944d305e967Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • dcef44679b67Revision changes
    • info

      endpoint added