WebhookApiClientInterface
Methods
createWebhookEndpoint()
createWebhookEndpoint(
params
,config?
):Promise
<SCWebhookEndpointType
>
Parameters
Parameter | Type |
---|---|
params | WebhookParamType |
config? | AxiosRequestConfig |
Returns
Promise
<SCWebhookEndpointType
>
deleteWebhookEndpoint()
deleteWebhookEndpoint(
id
,config?
):Promise
<any
>
Parameters
Parameter | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise
<any
>
expireWebhookSigningSecret()
expireWebhookSigningSecret(
id
,config?
):Promise
<SCWebhookEndpointType
>
Parameters
Parameter | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise
<SCWebhookEndpointType
>
getAllWebhookEndpointAttempts()
getAllWebhookEndpointAttempts(
id
,config?
):Promise
<SCPaginatedResponse
<SCWebhookEndpointAttemptType
>>
Parameters
Parameter | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise
<SCPaginatedResponse
<SCWebhookEndpointAttemptType
>>
getAllWebhookEndpoints()
getAllWebhookEndpoints(
config?
):Promise
<SCPaginatedResponse
<SCWebhookEndpointType
>>
Parameters
Parameter | Type |
---|---|
config? | AxiosRequestConfig |
Returns
Promise
<SCPaginatedResponse
<SCWebhookEndpointType
>>
getAllWebhookEvents()
getAllWebhookEvents(
config?
):Promise
<string
[]>
Parameters
Parameter | Type |
---|---|
config? | AxiosRequestConfig |
Returns
Promise
<string
[]>
getASpecificWebhookEndpoint()
getASpecificWebhookEndpoint(
id
,config?
):Promise
<SCWebhookEndpointType
>
Parameters
Parameter | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise
<SCWebhookEndpointType
>
resendMultipleWebhookEndpointEvent()
resendMultipleWebhookEndpointEvent(
id
,event
,config?
):Promise
<any
>
Parameters
Parameter | Type |
---|---|
id | string | number |
event | number [] |
config? | AxiosRequestConfig |
Returns
Promise
<any
>
resendWebhookEndpointEvent()
resendWebhookEndpointEvent(
id
,event
,config?
):Promise
<any
>
Parameters
Parameter | Type |
---|---|
id | string | number |
event | number |
config? | AxiosRequestConfig |
Returns
Promise
<any
>
revealWebhookSigningSecret()
revealWebhookSigningSecret(
id
,config?
):Promise
<SCWebhookEndpointSecretType
>
Parameters
Parameter | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise
<SCWebhookEndpointSecretType
>
updateASingleWebhookEndpointField()
updateASingleWebhookEndpointField(
id
,params
,config?
):Promise
<SCWebhookEndpointType
>
Parameters
Parameter | Type |
---|---|
id | string | number |
params | WebhookParamType |
config? | AxiosRequestConfig |
Returns
Promise
<SCWebhookEndpointType
>
updateASpecificWebhookEndpoint()
updateASpecificWebhookEndpoint(
id
,params
,config?
):Promise
<SCWebhookEndpointType
>
Parameters
Parameter | Type |
---|---|
id | string | number |
params | WebhookParamType |
config? | AxiosRequestConfig |
Returns
Promise
<SCWebhookEndpointType
>