Skip to main content

Usage

Access this class through the composio.webhookEndpoints property:

Methods

create()

Create a webhook endpoint for a toolkit + OAuth app pair. Returns the existing endpoint when one already exists for that pair.
Parameters Returns Promise<WebhookEndpoint> — The endpoint; register webhookUrl with the provider Example

get()

Retrieve a webhook endpoint by its nano id.
Parameters Returns Promise<WebhookEndpoint> — The endpoint, with secret setup values masked Example

list()

List webhook endpoints, optionally filtered by toolkit.
Parameters Returns Promise<WebhookEndpointListResponse> — The endpoints Example

replace()

Replace the setup fields of a webhook endpoint. All required setup fields for the toolkit must be provided — this is the initial configuration.
Parameters Returns Promise<WebhookEndpoint> — The configured endpoint Example

update()

Merge setup fields into a webhook endpoint. Omitted fields are preserved.
Parameters Returns Promise<WebhookEndpoint> — The updated endpoint Example