Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 04:45 UTC
| 1 | --- |
| 2 | title: Webhook Endpoints |
| 3 | description: "Per-OAuth-app webhook ingress endpoints. Inbound URLs the provider posts to, plus signing secret storage and verification." |
| 4 | --- |
| 5 | |
| 6 | {/* Auto-generated from OpenAPI spec. Edit the overview at api-overviews/webhook-endpoints.mdx, not this file. */} |
| 7 | |
| 8 | 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. |
| 9 | |
| 10 | 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. |
| 11 | |
| 12 | 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. |
| 13 | |
| 14 | 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). |
| 15 | |
| 16 | ## Endpoints |
| 17 | |
| 18 | <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"}]} /> |