Skip to main content

Interface: WebhookApiClientInterface

services/webhook.WebhookApiClientInterface

Methods

createWebhookEndpoint

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

Parameters

NameType
paramsWebhookParamType
config?AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Defined in

services/webhook/index.ts:11


deleteWebhookEndpoint

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/webhook/index.ts:15


expireWebhookSigningSecret

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Defined in

services/webhook/index.ts:17


getASpecificWebhookEndpoint

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Defined in

services/webhook/index.ts:12


getAllWebhookEndpointAttempts

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCWebhookEndpointAttemptType>>

Defined in

services/webhook/index.ts:16


getAllWebhookEndpoints

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

Parameters

NameType
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCWebhookEndpointType>>

Defined in

services/webhook/index.ts:9


getAllWebhookEvents

getAllWebhookEvents(config?): Promise<string[]>

Parameters

NameType
config?AxiosRequestConfig<any>

Returns

Promise<string[]>

Defined in

services/webhook/index.ts:10


resendMultipleWebhookEndpointEvent

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

Parameters

NameType
idstring | number
eventnumber[]
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/webhook/index.ts:20


resendWebhookEndpointEvent

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

Parameters

NameType
idstring | number
eventnumber
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/webhook/index.ts:19


revealWebhookSigningSecret

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

Parameters

NameType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointSecretType>

Defined in

services/webhook/index.ts:18


updateASingleWebhookEndpointField

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

Parameters

NameType
idstring | number
paramsWebhookParamType
config?AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Defined in

services/webhook/index.ts:14


updateASpecificWebhookEndpoint

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

Parameters

NameType
idstring | number
paramsWebhookParamType
config?AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Defined in

services/webhook/index.ts:13