Class WebhooksAPI

Webhooks API module - /v1/environment/webhooks

https://shipengine.github.io/shipengine-openapi/#tag/webhooks

Hierarchy

WebhooksAPI

Index

Constructors

Properties

Methods

create delete get list update

Constructors

constructor

new WebhooksAPI(client: AxiosInstance): WebhooksAPI
Parameters
- client: AxiosInstance
Returns WebhooksAPI
- Defined in javascript/src/webhooks/api.ts:17

Properties

`Private` client

client: AxiosInstance

Methods

create

create(webhook: SE.WebhookInput): Promise<AxiosResponse<SE.Webhook, any>>
The create method allows the creation of webhooks for a given user https://shipengine.github.io/shipengine-openapi/#operation/create_webhook

Returns
new WebHook created
Parameters
- webhook: SE.WebhookInput
  
  WebhookInput
Returns Promise<AxiosResponse<SE.Webhook, any>>
- Defined in javascript/src/webhooks/api.ts:39

delete

delete(webhookId: string): Promise<AxiosResponse<void, any>>
The delete method deletes a specific webhook for a given user by webhookId.

Returns
void
Parameters
- webhookId: string
  
  string
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/webhooks/api.ts:72

get

get(webhookId: string): Promise<AxiosResponse<SE.Webhook, any>>
The get method retrieves a given webhooks

Returns
WebHook
Parameters
- webhookId: string
  
  string
Returns Promise<AxiosResponse<SE.Webhook, any>>
- Defined in javascript/src/webhooks/api.ts:48

list

list(options?: ListWebhookOptions): Promise<AxiosResponse<SE.Webhook[], any>>
The list method retrieves a list of webhooks for a given user. https://shipengine.github.io/shipengine-openapi/#operation/list_webhooks
Parameters
- Optional options: ListWebhookOptions
Returns Promise<AxiosResponse<SE.Webhook[], any>>
- Defined in javascript/src/webhooks/api.ts:26

update

update(webhook: SE.Webhook): Promise<AxiosResponse<SE.Webhook, any>>
The update method updates a specific webhook for a given user by webhookId.

Returns
WebHook updated
Parameters
- webhook: SE.Webhook
  
  new Webhook to update
Returns Promise<AxiosResponse<SE.Webhook, any>>
- Defined in javascript/src/webhooks/api.ts:59

Generated using TypeDoc