nylas/com.nylas.resources/Webhooks

Webhooks

public final class Webhooks extends Resource<Webhook>

Nylas Webhooks API

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

Constructors

Webhooks

public Webhooks Webhooks(NylasClient client)

Functions

create

@JvmOverloads()

public final Response<WebhookWithSecret> create(CreateWebhookRequest requestBody)

@JvmOverloads()

public final Response<WebhookWithSecret> create(CreateWebhookRequest requestBody, RequestOverrides overrides)

Create a webhook destination

destroy

@JvmOverloads()

public final WebhookDeleteResponse destroy(String webhookId)

@JvmOverloads()

public final WebhookDeleteResponse destroy(String webhookId, RequestOverrides overrides)

Delete a webhook destination

extractChallengeParameter

public final String extractChallengeParameter(String url)

Extract the challenge parameter from a URL

find

@JvmOverloads()

public final Response<Webhook> find(String webhookId)

@JvmOverloads()

public final Response<Webhook> find(String webhookId, RequestOverrides overrides)

Return a webhook destination

ipAddresses

@JvmOverloads()

public final Response<WebhookIpAddressesResponse> ipAddresses()

@JvmOverloads()

public final Response<WebhookIpAddressesResponse> ipAddresses(RequestOverrides overrides)

Get the current list of IP addresses that Nylas sends webhooks from

list

@JvmOverloads()

public final ListResponse<Webhook> list()

@JvmOverloads()

public final ListResponse<Webhook> list(RequestOverrides overrides)

List all webhook destinations for the application

rotateSecret

@JvmOverloads()

public final Response<WebhookWithSecret> rotateSecret(String webhookId)

@JvmOverloads()

public final Response<WebhookWithSecret> rotateSecret(String webhookId, RequestOverrides overrides)

Update the webhook secret value for a destination

update

@JvmOverloads()

public final Response<Webhook> update(String webhookId, UpdateWebhookRequest requestBody)

@JvmOverloads()

public final Response<Webhook> update(String webhookId, UpdateWebhookRequest requestBody, RequestOverrides overrides)

Update a webhook destination