Skip to main content

Usage

Access this class through the composio.webhookSubscriptions property:

Methods

delete()

Delete a webhook subscription. Deliveries stop immediately.
Parameters Returns Promise<WebhookSubscriptionDeleteResponse> — \{ success \} Example

get()

Retrieve a webhook subscription by id.
Parameters Returns Promise<WebhookSubscription> — The subscription, including its signing secret Example

list()

List the project’s webhook subscriptions.
Parameters Returns Promise<WebhookSubscriptionListResponse> — Paginated subscriptions Example

listEventTypes()

List the event types a subscription can enable, with the payload versions each one supports.
Parameters Returns Promise<WebhookSubscriptionEventTypesResponse> — The available event types Example

rotateSecret()

Rotate the signing secret of a webhook subscription. The previous secret stops validating, so update your verifier with the returned secret.
Parameters Returns Promise<WebhookSubscriptionRotateSecretResponse> — \{ id, secret \} Example

set()

Create or update the project webhook subscription. If a subscription already exists it is updated in place, otherwise a new one is created. By default this subscribes to V3 trigger message events.
Parameters Returns Promise<WebhookSubscription> — The resulting subscription Example

update()

Update an existing webhook subscription. Only the provided fields change.
Parameters Returns Promise<WebhookSubscription> — The updated subscription Example