WebhookApiClientInterface

Methods

createWebhookEndpoint()

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

Parameters

Parameter	Type
params	WebhookParamType
config?	AxiosRequestConfig<any>

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:11

---

deleteWebhookEndpoint()

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

Parameters

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

Returns

Promise<any>

Source

services/webhook/index.ts:15

---

expireWebhookSigningSecret()

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

Parameters

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

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:17

---

getASpecificWebhookEndpoint()

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

Parameters

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

Returns

Promise<SCWebhookEndpointType>

Source

services/webhook/index.ts:12

---

getAllWebhookEndpointAttempts()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCWebhookEndpointAttemptType>>

Source

services/webhook/index.ts:16

---

getAllWebhookEndpoints()

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

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCWebhookEndpointType>>

Source

services/webhook/index.ts:9

---

getAllWebhookEvents()

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

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<string[]>

Source

services/webhook/index.ts:10

---

resendMultipleWebhookEndpointEvent()

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:20

---

resendWebhookEndpointEvent()

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:19

---

revealWebhookSigningSecret()

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

Parameters

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

Returns

Promise<SCWebhookEndpointSecretType>

Source

services/webhook/index.ts:18

---

updateASingleWebhookEndpointField()

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:14

---

updateASpecificWebhookEndpoint()

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:13