Skip to main content

WebhookApiClientInterface

Methods

createWebhookEndpoint()

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

Parameters

ParameterType
paramsWebhookParamType
config?AxiosRequestConfig

Returns

Promise<SCWebhookEndpointType>


deleteWebhookEndpoint()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


expireWebhookSigningSecret()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCWebhookEndpointType>


getAllWebhookEndpointAttempts()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCWebhookEndpointAttemptType>>


getAllWebhookEndpoints()

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

Parameters

ParameterType
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCWebhookEndpointType>>


getAllWebhookEvents()

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

Parameters

ParameterType
config?AxiosRequestConfig

Returns

Promise<string[]>


getASpecificWebhookEndpoint()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCWebhookEndpointType>


resendMultipleWebhookEndpointEvent()

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

Parameters

ParameterType
idstring | number
eventnumber[]
config?AxiosRequestConfig

Returns

Promise<any>


resendWebhookEndpointEvent()

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

Parameters

ParameterType
idstring | number
eventnumber
config?AxiosRequestConfig

Returns

Promise<any>


revealWebhookSigningSecret()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCWebhookEndpointSecretType>


updateASingleWebhookEndpointField()

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

Parameters

ParameterType
idstring | number
paramsWebhookParamType
config?AxiosRequestConfig

Returns

Promise<SCWebhookEndpointType>


updateASpecificWebhookEndpoint()

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

Parameters

ParameterType
idstring | number
paramsWebhookParamType
config?AxiosRequestConfig

Returns

Promise<SCWebhookEndpointType>