@devries-cameron20 / composio-1 / commits / 6ed8c7487
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

docs(triggers): repoint links to the split Webhook Subscriptions / Webhook Endpoints API pages

Apollo split the Webhooks tag into Webhook Subscriptions + Webhook Endpoints, so /reference/api-reference/webhook-subscriptions and /webhook-endpoints are the canonical pages now. Repoint: - glossary, creating-triggers, subscribing-to-events, webhook-verification, and the webhook-subscriptions changelog - delete the orphan /reference/api-reference/webhooks/index.mdx (and its v3 twin) — Apollo's openapi.json no longer routes any operation to the legacy Webhooks tag, but generate-api-index iterates only tags-with-operations, so the orphan never got auto-removed (separate script bug, follow-up) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Anshu Garg committed May 11, 2026 at 13:01 UTC 6ed8c7487dc2f46f3180456dd765a9de573c312d
7 files changed +7 -31
docs/content/changelog/02-06-26-webhook-subscriptions-api.mdx
+1 -1
@@ -19,7 +19,7 @@ A new API for managing webhook configurations with event filtering, HMAC signatu
19
20 ## API Overview
21
22 -See the [Webhook Subscriptions API Reference](/reference/api-reference/webhooks/postWebhookSubscriptions) for complete details.
22 +See the [Webhook Subscriptions API Reference](/reference/api-reference/webhook-subscriptions) for complete details.
23
24 ### Endpoints
25
docs/content/docs/glossary.mdx
+2 -2
@@ -124,11 +124,11 @@ A specific, active trigger scoped to a user's connected account.
124 </GlossaryTerm>
125
126 <GlossaryTerm name="Webhook Endpoint">
127 -The ingress URL Composio issues per OAuth app for webhook triggers, plus the signing secret used to verify each inbound request. Composio configures it for you in most cases. When a trigger type's `requires_webhook_endpoint_setup` flag is true, you configure it yourself once per OAuth app via the [Webhook Endpoints API](/reference/api-reference/webhooks/postWebhookEndpoints). See [Configuring the webhook endpoint](/docs/setting-up-triggers/creating-triggers#configuring-the-webhook-endpoint).
127 +The ingress URL Composio issues per OAuth app for webhook triggers, plus the signing secret used to verify each inbound request. Composio configures it for you in most cases. When a trigger type's `requires_webhook_endpoint_setup` flag is true, you configure it yourself once per OAuth app via the [Webhook Endpoints API](/reference/api-reference/webhook-endpoints). See [Configuring the webhook endpoint](/docs/setting-up-triggers/creating-triggers#configuring-the-webhook-endpoint).
128 </GlossaryTerm>
129
130 <GlossaryTerm name="Webhook Subscription">
131 -The URL Composio delivers signed events to in your application. One per project, configured via the dashboard or the [Webhook Subscriptions API](/reference/api-reference/webhooks/postWebhookSubscriptions). See [Subscribing to events](/docs/setting-up-triggers/subscribing-to-events).
131 +The URL Composio delivers signed events to in your application. One per project, configured via the dashboard or the [Webhook Subscriptions API](/reference/api-reference/webhook-subscriptions). See [Subscribing to events](/docs/setting-up-triggers/subscribing-to-events).
132 </GlossaryTerm>
133
134 <GlossaryTerm name="User ID">
docs/content/docs/setting-up-triggers/creating-triggers.mdx
+1 -1
@@ -41,7 +41,7 @@ Every inbound event is signature-checked at ingress before any trigger fires:
41 **Sharing one OAuth app across projects?** Consolidate to a single project or register separate OAuth apps per project before continuing.
42 </Callout>
43
44 -The walkthrough below uses Slack as the example and walks through the [Webhook Endpoints API](/reference/api-reference/webhooks/postWebhookEndpoints). For setup notes specific to each toolkit, see its FAQ section — e.g., [Slack](/toolkits/slack), [Notion](/toolkits/notion).
44 +The walkthrough below uses Slack as the example and walks through the [Webhook Endpoints API](/reference/api-reference/webhook-endpoints). For setup notes specific to each toolkit, see its FAQ section — e.g., [Slack](/toolkits/slack), [Notion](/toolkits/notion).
45
46 ### Step 1: Discover what credentials the endpoint needs
47
docs/content/docs/setting-up-triggers/subscribing-to-events.mdx
+1 -1
@@ -14,7 +14,7 @@ Webhooks are the recommended way to receive trigger events in production. To sta
14 | `composio.connected_account.expired` | Fired when a connected account expires and needs re-authentication. See [Subscribing to connection expiry events](/docs/subscribing-to-connection-expiry-events). |
15 | `composio.trigger.disabled` | **Fired when** Composio automatically disables a trigger — expired connection, webhook refresh failure, or unhealthy polling. **Not fired when** you disable a trigger through the manage API or deactivate its connected account via `PATCH /api/v3/connected_accounts/{id}/status`. |
16
17 -Set your webhook URL in the [dashboard settings](https://platform.composio.dev?next_page=/settings/webhook) or via the [Webhook Subscriptions API](/reference/api-reference/webhooks/postWebhookSubscriptions):
17 +Set your webhook URL in the [dashboard settings](https://platform.composio.dev?next_page=/settings/webhook) or via the [Webhook Subscriptions API](/reference/api-reference/webhook-subscriptions):
18
19 ```bash
20 curl -X POST https://backend.composio.dev/api/v3.1/webhook_subscriptions \
docs/content/docs/webhook-verification.mdx
+2 -2
@@ -11,7 +11,7 @@ Composio signs every webhook request. Always verify signatures in production to
11 The SDK handles signature verification, payload parsing, and version detection (V1, V2, V3).
12
13 <Callout>
14 -Store the webhook secret securely as `COMPOSIO_WEBHOOK_SECRET`. You can fetch it from the [webhook subscription](/reference/api-reference/webhooks/getWebhookSubscriptionsById) at any time or [rotate it](/reference/api-reference/webhooks/postWebhookSubscriptionsByIdRotateSecret) if it leaks.
14 +Store the webhook secret securely as `COMPOSIO_WEBHOOK_SECRET`. You can fetch it from the [webhook subscription](/reference/api-reference/webhook-subscriptions/getWebhookSubscriptionsById) at any time or [rotate it](/reference/api-reference/webhook-subscriptions/postWebhookSubscriptionsByIdRotateSecret) if it leaks.
15 </Callout>
16
17 <Tabs groupId="language" items={['Python', 'TypeScript']} persist>
@@ -61,7 +61,7 @@ An optional `tolerance` parameter (default: `300` seconds) controls how old a we
61 If you are not using the Composio SDK and want to verify signatures manually.
62
63 <Callout>
64 -Store the webhook secret securely as `COMPOSIO_WEBHOOK_SECRET`. You can fetch it from the [webhook subscription](/reference/api-reference/webhooks/getWebhookSubscriptionsById) at any time or [rotate it](/reference/api-reference/webhooks/postWebhookSubscriptionsByIdRotateSecret) if it leaks.
64 +Store the webhook secret securely as `COMPOSIO_WEBHOOK_SECRET`. You can fetch it from the [webhook subscription](/reference/api-reference/webhook-subscriptions/getWebhookSubscriptionsById) at any time or [rotate it](/reference/api-reference/webhook-subscriptions/postWebhookSubscriptionsByIdRotateSecret) if it leaks.
65 </Callout>
66
67 Every webhook request includes three headers: `webhook-signature`, `webhook-id`, and `webhook-timestamp`. Use these along with the raw request body to verify the signature:
docs/content/reference/api-reference/webhooks/index.mdx deleted
-12
@@ -1,12 +0,0 @@
1 ----
2 -title: Webhooks
3 -description: "Webhook configuration"
4 ----
5 -
6 -{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 -
8 -Webhook configuration
9 -
10 -## Endpoints
11 -
12 -<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/webhook_subscriptions","pathV3":"/api/v3/webhook_subscriptions","summary":"Create webhook subscription","href":"/reference/api-reference/webhooks/postWebhookSubscriptions"},{"method":"GET","pathV31":"/api/v3.1/webhook_subscriptions","pathV3":"/api/v3/webhook_subscriptions","summary":"List webhook subscriptions","href":"/reference/api-reference/webhooks/getWebhookSubscriptions"},{"method":"GET","pathV31":"/api/v3.1/webhook_subscriptions/{id}","pathV3":"/api/v3/webhook_subscriptions/{id}","summary":"Get webhook subscription","href":"/reference/api-reference/webhooks/getWebhookSubscriptionsById"},{"method":"PATCH","pathV31":"/api/v3.1/webhook_subscriptions/{id}","pathV3":"/api/v3/webhook_subscriptions/{id}","summary":"Update webhook subscription","href":"/reference/api-reference/webhooks/patchWebhookSubscriptionsById"},{"method":"DELETE","pathV31":"/api/v3.1/webhook_subscriptions/{id}","pathV3":"/api/v3/webhook_subscriptions/{id}","summary":"Delete webhook subscription","href":"/reference/api-reference/webhooks/deleteWebhookSubscriptionsById"},{"method":"POST","pathV31":"/api/v3.1/webhook_subscriptions/{id}/rotate_secret","pathV3":"/api/v3/webhook_subscriptions/{id}/rotate_secret","summary":"Rotate webhook secret","href":"/reference/api-reference/webhooks/postWebhookSubscriptionsByIdRotateSecret"},{"method":"GET","pathV31":"/api/v3.1/webhook_subscriptions/event_types","pathV3":"/api/v3/webhook_subscriptions/event_types","summary":"List available event types","href":"/reference/api-reference/webhooks/getWebhookSubscriptionsEventTypes"},{"method":"POST","pathV31":"/api/v3.1/webhook_endpoints","pathV3":"/api/v3/webhook_endpoints","summary":"Create webhook endpoint","href":"/reference/api-reference/webhooks/postWebhookEndpoints"},{"method":"GET","pathV31":"/api/v3.1/webhook_endpoints","pathV3":"/api/v3/webhook_endpoints","summary":"List webhook endpoints","href":"/reference/api-reference/webhooks/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/webhooks/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/webhooks/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/webhooks/patchWebhookEndpointsByNanoId"}]} />
docs/content/reference/v3/api-reference/webhooks/index.mdx deleted
-12
@@ -1,12 +0,0 @@
1 ----
2 -title: Webhooks
3 -description: "Webhook configuration"
4 ----
5 -
6 -{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 -
8 -Webhook configuration
9 -
10 -## Endpoints
11 -
12 -<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/webhook_subscriptions","pathV3":"/api/v3/webhook_subscriptions","summary":"Create webhook subscription","href":"/reference/v3/api-reference/webhooks/postWebhookSubscriptions"},{"method":"GET","pathV31":"/api/v3.1/webhook_subscriptions","pathV3":"/api/v3/webhook_subscriptions","summary":"List webhook subscriptions","href":"/reference/v3/api-reference/webhooks/getWebhookSubscriptions"},{"method":"GET","pathV31":"/api/v3.1/webhook_subscriptions/{id}","pathV3":"/api/v3/webhook_subscriptions/{id}","summary":"Get webhook subscription","href":"/reference/v3/api-reference/webhooks/getWebhookSubscriptionsById"},{"method":"PATCH","pathV31":"/api/v3.1/webhook_subscriptions/{id}","pathV3":"/api/v3/webhook_subscriptions/{id}","summary":"Update webhook subscription","href":"/reference/v3/api-reference/webhooks/patchWebhookSubscriptionsById"},{"method":"DELETE","pathV31":"/api/v3.1/webhook_subscriptions/{id}","pathV3":"/api/v3/webhook_subscriptions/{id}","summary":"Delete webhook subscription","href":"/reference/v3/api-reference/webhooks/deleteWebhookSubscriptionsById"},{"method":"POST","pathV31":"/api/v3.1/webhook_subscriptions/{id}/rotate_secret","pathV3":"/api/v3/webhook_subscriptions/{id}/rotate_secret","summary":"Rotate webhook secret","href":"/reference/v3/api-reference/webhooks/postWebhookSubscriptionsByIdRotateSecret"},{"method":"GET","pathV31":"/api/v3.1/webhook_subscriptions/event_types","pathV3":"/api/v3/webhook_subscriptions/event_types","summary":"List available event types","href":"/reference/v3/api-reference/webhooks/getWebhookSubscriptionsEventTypes"},{"method":"POST","pathV31":"/api/v3.1/webhook_endpoints","pathV3":"/api/v3/webhook_endpoints","summary":"Create webhook endpoint","href":"/reference/v3/api-reference/webhooks/postWebhookEndpoints"},{"method":"GET","pathV31":"/api/v3.1/webhook_endpoints","pathV3":"/api/v3/webhook_endpoints","summary":"List webhook endpoints","href":"/reference/v3/api-reference/webhooks/getWebhookEndpoints"},{"method":"GET","pathV31":"/api/v3.1/webhook_endpoints/{nano_id}","pathV3":"/api/v3/webhook_endpoints/{nano_id}","summary":"Get webhook endpoint","href":"/reference/v3/api-reference/webhooks/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/v3/api-reference/webhooks/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/v3/api-reference/webhooks/patchWebhookEndpointsByNanoId"}]} />