Class Webhooks

Nylas Webhooks API

The Nylas Webhooks API allows your application to receive notifications in real-time when certain events occur.

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch create destroy extractChallengeParameter find ipAddresses list rotateSecret update

Constructors

constructor

new Webhooks(apiClient: APIClient): Webhooks
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Webhooks
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:170

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:184

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:144

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:199

`Protected`_getStream

_getStream(__namedParameters: FindParams<void>): Promise<ReadableStream>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:212

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:124

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:174

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:178

create

create(
__namedParameters: CreateWebhookParams & Overrides,
): Promise<NylasResponse<WebhookWithSecret>>
Create a webhook destination
Parameters
- __namedParameters: CreateWebhookParams & Overrides
Returns Promise<NylasResponse<WebhookWithSecret>>
The created webhook destination
- Defined in src/resources/webhooks.ts:80

destroy

destroy(
__namedParameters: DestroyWebhookParams & Overrides,
): Promise<WebhookDeleteResponse>
Delete a webhook destination
Parameters
- __namedParameters: DestroyWebhookParams & Overrides
Returns Promise<WebhookDeleteResponse>
The deletion response
- Defined in src/resources/webhooks.ts:113

extractChallengeParameter

extractChallengeParameter(url: string): string
Extract the challenge parameter from a URL
Parameters
- url: string
  The URL sent by Nylas containing the challenge parameter
Returns string
The challenge parameter
- Defined in src/resources/webhooks.ts:160

find

find(
__namedParameters: FindWebhookParams & Overrides,
): Promise<NylasResponse<Webhook>>
Return a webhook destination
Parameters
- __namedParameters: FindWebhookParams & Overrides
Returns Promise<NylasResponse<Webhook>>
The webhook destination
- Defined in src/resources/webhooks.ts:66

ipAddresses

ipAddresses(
__namedParameters?: Overrides,
): Promise<NylasResponse<WebhookIpAddressesResponse>>
Get the current list of IP addresses that Nylas sends webhooks from
Parameters
- __namedParameters: Overrides = {}
Returns Promise<NylasResponse<WebhookIpAddressesResponse>>
The list of IP addresses that Nylas sends webhooks from
- Defined in src/resources/webhooks.ts:146

list

list(
__namedParameters?: Overrides,
): AsyncListResponse<NylasListResponse<Webhook>>
List all webhook destinations for the application
Parameters
- __namedParameters: Overrides = {}
Returns AsyncListResponse<NylasListResponse<Webhook>>
The list of webhook destinations
- Defined in src/resources/webhooks.ts:53

rotateSecret

rotateSecret(
__namedParameters: DestroyWebhookParams & Overrides,
): Promise<NylasResponse<WebhookWithSecret>>
Update the webhook secret value for a destination
Parameters
- __namedParameters: DestroyWebhookParams & Overrides
Returns Promise<NylasResponse<WebhookWithSecret>>
The updated webhook destination with the webhook secret
- Defined in src/resources/webhooks.ts:127

update

update(
__namedParameters: UpdateWebhookParams & Overrides,
): Promise<NylasResponse<Webhook>>
Update a webhook destination
Parameters
- __namedParameters: UpdateWebhookParams & Overrides
Returns Promise<NylasResponse<Webhook>>
The updated webhook destination
- Defined in src/resources/webhooks.ts:97