Skip to main content
POST
Create webhook subscription

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Body

application/json
webhook_url
string<uri>
required

HTTPS URL to receive webhook events

Maximum string length: 2048
enabled_events
string[]
required

Array of event types to subscribe to

Minimum array length: 1
version
enum<string>
default:V3

Webhook payload version

Available options:
V1,
V2,
V3

Response

Webhook subscription created

id
string<webhookSubscriptionId>
required

Unique subscription ID

webhook_url
string
required

Webhook destination URL

version
enum<string>
required

Webhook payload version

Available options:
V1,
V2,
V3
enabled_events
string[]
required

Subscribed event types

secret
string
required

Signing secret for HMAC verification

created_at
string
required

ISO 8601 timestamp

updated_at
string
required

ISO 8601 timestamp