Class WebhooksService

Webhooks service

Hierarchy

WebhooksService

Index

Constructors

Properties

httpClient namespace namespaceIncoming

Methods

createWebhook deleteSelectedWebhooks deleteWebhook getNamespace getWebhookById getWebhooks repeatWebhook toggleWebhook updateWebhook

Constructors

constructor

new WebhooksService(httpClient): WebhooksService
Parameters
- httpClient: HttpClient
Returns WebhooksService

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/company/v1/webhooks'

`Private` namespaceIncoming

namespaceIncoming: string = '/company/v1/incoming_webhooks'

Methods

createWebhook

createWebhook(body, isIncoming?): Promise<AxiosResponse<number, any>>
Create webhook
Parameters
- body: IWebhookRequest
  
  webhook fields
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<number, any>>

deleteSelectedWebhooks

deleteSelectedWebhooks(ids, isIncoming?): Promise<AxiosResponse<number[], any>>
Delete webhooks
Parameters
- ids: number[]
  
  ids array
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<number[], any>>

deleteWebhook

deleteWebhook(id, isIncoming?): Promise<AxiosResponse<number, any>>
Delete webhook
Parameters
- id: number
  
  webhook id
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<number, any>>

`Private` getNamespace

getNamespace(prefix?): string
Parameters
- Optional prefix: boolean
Returns string

getWebhookById

getWebhookById(id, isIncoming?): Promise<AxiosResponse<IWebhook, any>>
Get webhook object
Parameters
- id: number
  
  webhook id
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<IWebhook, any>>
Webhook object

getWebhooks

getWebhooks(page, list?, name?, isIncoming?): Promise<AxiosResponse<IWebhooksResponse, any>>
Get webhooks list
Parameters
- page: number
- Optional list: number
- Optional name: string
- Optional isIncoming: boolean
Returns Promise<AxiosResponse<IWebhooksResponse, any>>
Array webhooks entity

repeatWebhook

repeatWebhook(id, isIncoming?): Promise<AxiosResponse<any, any>>
Repeat webhook
Parameters
- id: number
  
  webhook id
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<any, any>>

toggleWebhook

toggleWebhook(id, isIncoming?): Promise<AxiosResponse<any, any>>
Toggle webhook
Parameters
- id: number
  
  webhook id
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<any, any>>

updateWebhook

updateWebhook(id, body, isIncoming?): Promise<AxiosResponse<number[], any>>
Update webhook
Parameters
- id: number
  
  webhook id
- body: Partial<IWebhookRequest>
  
  fields to update
- Optional isIncoming: boolean
  
  optional param, for incoming webhook
Returns Promise<AxiosResponse<number[], any>>

Generated using TypeDoc