API Reference

Webhook Endpoints

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, which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see Webhook verification. To set up the trigger events those payloads carry, see Triggers.

Endpoints

EndpointQuick Link
POST /api/v3.1/webhook_endpointsCreate webhook endpoint
GET /api/v3.1/webhook_endpointsList webhook endpoints
GET /api/v3.1/webhook_endpoints/{nano_id}Get webhook endpoint
POST /api/v3.1/webhook_endpoints/{nano_id}Put webhook endpoint configuration
PATCH /api/v3.1/webhook_endpoints/{nano_id}Update webhook endpoint configuration

On this page