mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Abhishek Patil
0f0ca14a8f
## Summary
- Refresh the checked-in v3.1 and v3 OpenAPI snapshots from the live
backend specs using `bun run scripts/fetch-openapi.mjs`.
- Regenerate API reference index pages with `bun run
generate:api-index`.
- Surfaces `DELETE /api/v3.1/tool_router/session/{session_id}` in the
Tool Router API reference.
- Includes the other upstream generated spec changes from the same
auto-fetch, including generated API Keys and Organization Management
section indexes.
## Verification
- `bun run scripts/fetch-openapi.mjs`
- `bun run generate:api-index`
- `git diff --check`
- `bun run build`
## Notes before merge
- This is intentionally the full auto-generated OpenAPI refresh, not the
surgical two-file patch.
- The generated backend OpenAPI still contains some `internal` wording
in descriptions; left as-is to preserve the auto-generated output.
- Confirm the newly generated API Keys / Organization Management
sections are intended to publish with this refresh.
---------
Co-authored-by: jkomyno <alberto@composio.dev>
19 lines
2.4 KiB
Plaintext
19 lines
2.4 KiB
Plaintext
---
|
|
title: Webhook Endpoints
|
|
description: "Per-OAuth-app webhook ingress endpoints. Inbound URLs the provider posts to, plus signing secret storage and verification."
|
|
---
|
|
|
|
{/* Auto-generated from OpenAPI spec. Edit the overview at api-overviews/webhook-endpoints.mdx, not this file. */}
|
|
|
|
Webhook endpoints are per-OAuth-app webhook ingress configurations. They define the inbound URL a provider posts events to, along with the signing secret Composio stores and uses to verify those incoming payloads.
|
|
|
|
Reach for these endpoints when an OAuth app you have configured needs to deliver provider-side events into Composio. You create an endpoint, configure or update it by its `nano_id`, and store the signing secret Composio uses to authenticate inbound requests.
|
|
|
|
Each endpoint is addressed by its `nano_id`. The `POST` to `/webhook_endpoints/{nano_id}` replaces the full configuration, while `PATCH` updates it in place.
|
|
|
|
This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
|
|
|
|
## Endpoints
|
|
|
|
<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/webhook_endpoints","pathV3":"/api/v3/webhook_endpoints","summary":"Create webhook endpoint","href":"/reference/api-reference/webhook-endpoints/postWebhookEndpoints"},{"method":"GET","pathV31":"/api/v3.1/webhook_endpoints","pathV3":"/api/v3/webhook_endpoints","summary":"List webhook endpoints","href":"/reference/api-reference/webhook-endpoints/getWebhookEndpoints"},{"method":"GET","pathV31":"/api/v3.1/webhook_endpoints/{nano_id}","pathV3":"/api/v3/webhook_endpoints/{nano_id}","summary":"Get webhook endpoint","href":"/reference/api-reference/webhook-endpoints/getWebhookEndpointsByNanoId"},{"method":"POST","pathV31":"/api/v3.1/webhook_endpoints/{nano_id}","pathV3":"/api/v3/webhook_endpoints/{nano_id}","summary":"Put webhook endpoint configuration","href":"/reference/api-reference/webhook-endpoints/postWebhookEndpointsByNanoId"},{"method":"PATCH","pathV31":"/api/v3.1/webhook_endpoints/{nano_id}","pathV3":"/api/v3/webhook_endpoints/{nano_id}","summary":"Update webhook endpoint configuration","href":"/reference/api-reference/webhook-endpoints/patchWebhookEndpointsByNanoId"}]} />
|