Class WebhooksApi

WebhooksApi - object-oriented interface

Export

Hierarchy

BaseAPI
- WebhooksApi

Implements

WebhooksApiInterface

Index

Constructors

constructor

new WebhooksApi(configuration?, basePath?, axios?): WebhooksApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns WebhooksApi
Inherited from BaseAPI.constructor
- Defined in src/base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: Configuration

Methods

adminCreateWebhook

adminCreateWebhook(groupId, appId, serviceId, body, options?): Promise<AxiosResponse<void, any>>
Create a webhook.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- serviceId: any
  
  The unique `_id` value of a service.
- body: any
  
  The webhook to create.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Create a webhook

Throws

Memberof
WebhooksApi
Implementation of WebhooksApiInterface.adminCreateWebhook
- Defined in src/api.ts:22577

adminDeleteWebhook

adminDeleteWebhook(groupId, appId, serviceId, incomingWebhookId, options?): Promise<AxiosResponse<void, any>>
Delete a webhook.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- serviceId: any
  
  The unique `_id` value of a service.
- incomingWebhookId: any
  
  The unique `_id` value of an incoming webhook
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Delete a webhook

Throws

Memberof
WebhooksApi
Implementation of WebhooksApiInterface.adminDeleteWebhook
- Defined in src/api.ts:22592

adminGetWebhook

adminGetWebhook(groupId, appId, serviceId, incomingWebhookId, options?): Promise<AxiosResponse<void, any>>
Retrieve a webhook.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- serviceId: any
  
  The unique `_id` value of a service.
- incomingWebhookId: any
  
  The unique `_id` value of an incoming webhook
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Retrieve a webhook

Throws

Memberof
WebhooksApi
Implementation of WebhooksApiInterface.adminGetWebhook
- Defined in src/api.ts:22607

adminListWebhooks

adminListWebhooks(groupId, appId, serviceId, options?): Promise<AxiosResponse<any, any>>
List webhooks.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- serviceId: any
  
  The unique `_id` value of a service.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<any, any>>

Summary
List webhooks

Throws

Memberof
WebhooksApi
Implementation of WebhooksApiInterface.adminListWebhooks
- Defined in src/api.ts:22621

adminUpdateWebhook

adminUpdateWebhook(groupId, appId, serviceId, incomingWebhookId, body, options?): Promise<AxiosResponse<void, any>>
Update a webhook.
Parameters
- groupId: any
  
  An Atlas Project/Group ID.
- appId: any
  
  The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
- serviceId: any
  
  The unique `_id` value of a service.
- incomingWebhookId: any
  
  The unique `_id` value of an incoming webhook
- body: any
  
  The updated state of the webhook.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Update a webhook

Throws

Memberof
WebhooksApi
Implementation of WebhooksApiInterface.adminUpdateWebhook
- Defined in src/api.ts:22637

Class WebhooksApi

Export

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns WebhooksApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

adminCreateWebhook

Parameters

groupId: any

appId: any

serviceId: any

body: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminDeleteWebhook

Parameters

groupId: any

appId: any

serviceId: any

incomingWebhookId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminGetWebhook

Parameters

groupId: any

appId: any

serviceId: any

incomingWebhookId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

adminListWebhooks

Parameters

groupId: any

appId: any

serviceId: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<any, any>>

Summary

Throws

Memberof

adminUpdateWebhook

Parameters

groupId: any

appId: any

serviceId: any

incomingWebhookId: any

body: any

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>