How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Airweave webhooks API

The webhooks API from Airweave — 5 operation(s) for webhooks.

Airweave webhooks API is one of 5 APIs that Airweave publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.airweave.ai, http://localhost:8001.

8 operations 5 paths 15 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.airweave.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Airweave webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (default).

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

webhooks 8
GET
/webhooks/messages
List Messages
get-messages-webhooks-messages-get 2 params → 200422429
GET
/webhooks/messages/{message_id}
Get Message
get-message-webhooks-messages-message-id-get 3 params → 200404422429
GET
/webhooks/subscriptions
List Subscriptions
get-subscriptions-webhooks-subscriptions-get 1 param → 200422429
POST
/webhooks/subscriptions
Create Subscription
create-subscription-webhooks-subscriptions-post 1 param body → 200422429
GET
/webhooks/subscriptions/{subscription_id}
Get Subscription
get-subscription-webhooks-subscriptions-subscription-id-get 3 params → 200404422429
PATCH
/webhooks/subscriptions/{subscription_id}
Update Subscription
patch-subscription-webhooks-subscriptions-subscription-id-patch 2 params body → 200404422429
DELETE
/webhooks/subscriptions/{subscription_id}
Delete Subscription
delete-subscription-webhooks-subscriptions-subscription-id-delete 2 params → 200404422429
POST
/webhooks/subscriptions/{subscription_id}/recover
Recover Failed Messages
recover-failed-messages-webhooks-subscriptions-subscription-id-recover-post 2 params body → 200404422429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are WebhookSubscriptionDetail (10 properties), WebhookSubscription (8 properties), DeliveryAttempt (8 properties), WebhookMessageWithAttempts (7 properties). Each schema is shown below with its type and property counts.

RecoverMessagesRequest
object
Request to retry failed message deliveries. Use this to replay events that failed to deliver during a specific time window, for example after fixing an issue w…
2 properties 1 required
ValidationErrorDetail
object
Details about a validation error for a specific field.
3 properties 3 required
WebhookSubscriptionDetail
object
Full subscription detail, including delivery attempts and signing secret. Returned by GET /subscriptions/{id} only.
10 properties 4 required
EventType
string
PatchSubscriptionRequest
object
Update an existing webhook subscription. All fields are optional. Only provided fields will be updated; omitted fields retain their current values. When re-ena…
4 properties
ValidationErrorResponse
object
Response returned when request validation fails (HTTP 422). This occurs when the request body contains invalid data, such as malformed URLs, invalid event type…
1 property 1 required
WebhookMessage
object
A webhook message that was sent (or attempted) to webhook subscribers. The payload contains the actual event data matching the webhook delivery format.
6 properties 4 required
RecoveryTask
object
Information about a message recovery task. When you trigger a recovery of failed messages, this object is returned to track the recovery progress. The status i…
2 properties 2 required
HealthStatus
string
Health status of a webhook subscription based on recent delivery attempts.
WebhookSubscription
object
A webhook subscription (endpoint) configuration. This is the lightweight representation returned by list, create, update, and delete endpoints. For the full de…
8 properties 4 required
RateLimitErrorResponse
object
Response returned when rate limit is exceeded (HTTP 429). The API enforces rate limits to ensure fair usage. When exceeded, wait for the duration specified in…
1 property 1 required
WebhookMessageWithAttempts
object
A webhook message with delivery attempts.
7 properties 4 required
DeliveryAttempt
object
A delivery attempt for a webhook message. Each time Airweave attempts to deliver a message to your webhook endpoint, a delivery attempt is recorded. Failed att…
8 properties 6 required
CreateSubscriptionRequest
object
Create a new webhook subscription. Webhook subscriptions define where Airweave should send event notifications. You can subscribe to specific event types to re…
3 properties 2 required
NotFoundErrorResponse
object
Response returned when a resource is not found (HTTP 404).
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airweave-webhooks-api-openapi.yml Raw ↑

Other APIs Airweave publishes across the network.

Airweave collections API
Airweave collections > search API
Airweave source-connections API
Airweave sources API
Where this information came from

This is an independent, third-party profile of Airweave webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.