Class WebhooksEndpoints

Index

Constructors

Methods

list create retrieve delete ping logs

Constructors

constructor

new WebhooksEndpoints(authToken: string): WebhooksEndpoints
Parameters
- authToken: string
Returns WebhooksEndpoints
- Defined in packages/up-api/src/endpoints/webhooks.ts:16

Methods

list

list(pageSize?: number): Promise<ListWebhooksResponse>
Parameters
- OptionalpageSize: number
Returns Promise<ListWebhooksResponse>
- Defined in packages/up-api/src/endpoints/webhooks.ts:21

create

create(payload: CreateWebhookPayload): Promise<CreateWebhookResponse>
Parameters
- payload: CreateWebhookPayload
Returns Promise<CreateWebhookResponse>
- Defined in packages/up-api/src/endpoints/webhooks.ts:38

retrieve

retrieve(id: string): Promise<RetrieveWebhookResponse>
Parameters
- id: string
Returns Promise<RetrieveWebhookResponse>
- Defined in packages/up-api/src/endpoints/webhooks.ts:55

delete

delete(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in packages/up-api/src/endpoints/webhooks.ts:70

ping

ping(webhookId: string): Promise<WebhookPingResponse>
Parameters
- webhookId: string
Returns Promise<WebhookPingResponse>
- Defined in packages/up-api/src/endpoints/webhooks.ts:85

logs

logs(webhookId: string, pageSize?: number): Promise<ListWebhookLogsResponse>
Parameters
- webhookId: string
- OptionalpageSize: number
Returns Promise<ListWebhookLogsResponse>
- Defined in packages/up-api/src/endpoints/webhooks.ts:100