AIairweave-ai
webhooks

Get Subscription

Changed on

Retrieve a specific webhook subscription with its recent delivery attempts.

Returns the subscription configuration along with a history of message delivery attempts. This is useful for debugging delivery issues or verifying that your endpoint is correctly receiving events.

Use include_secret=true to also retrieve the signing secret for webhook signature verification. Keep this secret secure.

get/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 retrieve (UUID).

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

Query parameters

include_secretboolean

Include the signing secret for webhook signature verification. Keep this secret secure and use it to verify the 'svix-signature' header.

Response

Subscription with delivery attempts

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.

secretstring nullable

The signing secret for webhook signature verification. Only included when include_secret=true is passed to the API. Keep this secret secure.

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