WebhookService

Webhook service can be used in the following way:

1. Import the service from our library:

import {WebhookService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllWebhookEndpoints` will return the paginated list of webhook endpoints.

async getAllWebhookEndpoints() {
      return await WebhookService.getAllWebhookEndpoints();
     }

In case of required `params`, just add them inside the brackets.

async getASpecificWebhookEndpoint(webhookId) {
       return await WebhookService.getASpecificWebhookEndpoint(webhookId);
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

 const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

new WebhookService()

new WebhookService(): WebhookService

Returns

WebhookService

Methods

createWebhookEndpoint()

static createWebhookEndpoint(params, config?): Promise<SCWebhookEndpointType>

Parameters

Parameter	Type
params	WebhookParamType
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:194

---

deleteWebhookEndpoint()

static deleteWebhookEndpoint(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/webhook/index.ts:214

---

expireWebhookSigningSecret()

static expireWebhookSigningSecret(id, config?): Promise<SCWebhookEndpointType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:223

---

getASpecificWebhookEndpoint()

static getASpecificWebhookEndpoint(id, config?): Promise<SCWebhookEndpointType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:197

---

getAllWebhookEndpointAttempts()

static getAllWebhookEndpointAttempts(id, config?): Promise <SCPaginatedResponse<SCWebhookEndpointAttemptType>>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCWebhookEndpointAttemptType>>

Source

services/webhook/index.ts:217

---

getAllWebhookEndpoints()

static getAllWebhookEndpoints(config?): Promise <SCPaginatedResponse<SCWebhookEndpointType>>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCWebhookEndpointType>>

Source

services/webhook/index.ts:188

---

getAllWebhookEvents()

static getAllWebhookEvents(config?): Promise<any>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/webhook/index.ts:191

---

resendMultipleWebhookEndpointEvent()

static resendMultipleWebhookEndpointEvent(id, event, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
event	number[]
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/webhook/index.ts:232

---

resendWebhookEndpointEvent()

static resendWebhookEndpointEvent(id, event, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
event	number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/webhook/index.ts:229

---

revealWebhookSigningSecret()

static revealWebhookSigningSecret(id, config?): Promise<SCWebhookEndpointSecretType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointSecretType>

Source

services/webhook/index.ts:226

---

updateASingleWebhookEndpointField()

static updateASingleWebhookEndpointField(id, params, config?): Promise<SCWebhookEndpointType>

Parameters

Parameter	Type
id	string | number
params	WebhookParamType
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:207

---

updateASpecificWebhookEndpoint()

static updateASpecificWebhookEndpoint(id, params, config?): Promise<SCWebhookEndpointType>

Parameters

Parameter	Type
id	string | number
params	WebhookParamType
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:200