Webhook Subscriptions

Create webhook subscription

Changed on

Creates a webhook subscription for the authenticated project. Only one subscription is allowed per project. The signing secret is returned in subscription responses.

post/api/v3.1/webhook_subscriptions

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/webhook_subscriptions
  • Auth
    API key in header x-api-key

Request body

webhook_urlstring uri required

HTTPS URL to receive webhook events

enabled_eventsstring[] required

Array of event types to subscribe to

version'V1' | 'V2' | 'V3'

Webhook payload version

Response

Webhook subscription created

idstring webhookSubscriptionId required

Unique subscription ID

webhook_urlstring required

Webhook destination URL

version'V1' | 'V2' | 'V3' required

Webhook payload version

enabled_eventsstring[] required

Subscribed event types

secretstring required

Signing secret for HMAC verification

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id postV3_1WebhookSubscriptions removed and replaced with postWebhookSubscriptions

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API