Usage
Access this class through thecomposio.webhookSubscriptions property:
Methods
delete()
Delete a webhook subscription. Deliveries stop immediately.
Returns
Promise<WebhookSubscriptionDeleteResponse> — \{ success \}
Example
get()
Retrieve a webhook subscription by id.
Returns
Promise<WebhookSubscription> — The subscription, including its signing secret
Example
list()
List the project’s webhook subscriptions.
Returns
Promise<WebhookSubscriptionListResponse> — Paginated subscriptions
Example
listEventTypes()
List the event types a subscription can enable, with the payload versions each one supports.
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 returnedsecret.
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.
Returns
Promise<WebhookSubscription> — The resulting subscription
Example
update()
Update an existing webhook subscription. Only the provided fields change.
Returns
Promise<WebhookSubscription> — The updated subscription
Example