Webhook Endpoints

Put webhook endpoint configuration

Changed on

Full replacement of webhook endpoint configuration. All required setup fields must be provided. Use PATCH to update individual fields.

post/api/v3.1/webhook_endpoints/{nano_id}

Request

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

Path parameters

nano_idstring required

Webhook endpoint nano ID (e.g., we_abc123)

Request body

dataobject required

Key-value pairs for ALL required setup_fields. Unlike PATCH, all required fields must be provided — this is initial configuration.

Response

Configured

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_1WebhookEndpointsByNanoId removed and replaced with postWebhookEndpointsByNanoId

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API