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