WebhooksApi | byu-event-hub-sdk

WebhooksApi - object-oriented interface

Hierarchy

BaseAPI
- WebhooksApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebhooksApi(fetch?: FetchAPI, basePath?: string): WebhooksApi

Inherited from BaseAPI.constructor
- Defined in api.ts:31
Parameters
- Default value fetch: FetchAPI = isomorphicFetch
- Default value basePath: string = BASE_PATH
Returns WebhooksApi

Properties

basePath

basePath: string

fetch

fetch: FetchAPI

Methods

deleteWebhook

deleteWebhook(options?: any): Promise<any>

- Defined in api.ts:2786
Delete a webhook

Parameters
- Optional options: any
Returns Promise<any>

getWebhooks

getWebhooks(params: object, options?: any): Promise<any>

- Defined in api.ts:2797
Retrieve a collection of webhooks

Parameters
- params: object
  - Optional endpoint?: string
  - identityId: string
  - Optional identityName?: string
  - Optional pushOption?: string
- Optional options: any
Returns Promise<any>

modifyWebhook

modifyWebhook(params: object, options?: any): Promise<any>

- Defined in api.ts:2805
Modify a webhook

Parameters
- params: object
  - body: Body6
- Optional options: any
Returns Promise<any>

registerWebhook

registerWebhook(params: object, options?: any): Promise<any>

- Defined in api.ts:2813
Register webhook Register webhook

Parameters
- params: object
  - body: Body7
- Optional options: any
Returns Promise<any>

webhooksOptions

webhooksOptions(options?: any): Promise<string[]>

- Defined in api.ts:2820
What can this endpoint do?

Parameters
- Optional options: any
Returns Promise<string[]>