Webhook Endpoints

Create webhook endpoint

Changed on

Creates a shared webhook endpoint for a toolkit + OAuth app + project. Returns the webhook URL that the customer registers in their app dashboard. Idempotent — returns existing endpoint if one already exists for this toolkit + client_id + project.

post/api/v3.1/webhook_endpoints

Request

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

Request body

toolkit_slugstring required

Toolkit identifier (e.g., slack, discord)

client_idstring required

OAuth app client ID — identifies which app this endpoint is for

Response

Existing webhook endpoint returned

idstring required

Webhook endpoint nano ID

toolkit_slugstring required

Toolkit this endpoint is for

client_idstring nullable required

OAuth app client ID

webhook_urlstring required

The webhook URL to register with the provider

dataobject nullable required

Configured fields with secret values masked

created_atstring required

ISO 8601 timestamp

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id postV3_1WebhookEndpoints removed and replaced with postWebhookEndpoints

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API