Class WebhooksApi

Hierarchy

ConversationDomainApi
- WebhooksApi

Index

Methods

create delete get list update

Methods

create

create(data: CreateWebhookRequestData): Promise<Webhook>
Create a new webhook Creates a webhook for receiving callbacks on specific triggers. You can create up to 5 webhooks per app.
Parameters
- data: CreateWebhookRequestData
  The data to provide to the API call.
Returns Promise<Webhook>

delete

delete(data: DeleteWebhookRequestData): Promise<any>
Delete an existing webhook Deletes a webhook as specified by the webhook ID.
Parameters
- data: DeleteWebhookRequestData
  The data to provide to the API call.
Returns Promise<any>

get

get(data: GetWebhookRequestData): Promise<Webhook>
Get a webhook Get a webhook as specified by the webhook ID.
Parameters
- data: GetWebhookRequestData
  The data to provide to the API call.
Returns Promise<Webhook>

list

list(data: ListWebhooksRequestData): Promise<ListWebhooksResponse>
List webhooks List all webhooks for a given app as specified by the App ID.
Parameters
- data: ListWebhooksRequestData
  The data to provide to the API call.
Returns Promise<ListWebhooksResponse>

update

update(data: UpdateWebhookRequestData): Promise<Webhook>
Update an existing webhook Updates an existing webhook as specified by the webhook ID.
Parameters
- data: UpdateWebhookRequestData
  The data to provide to the API call.
Returns Promise<Webhook>