Skip to Content

Remove the mailbox's event webhook.

Deletes the hook: event batches stop immediately and nothing is retained. Any batch already in flight completes its retry ladder against nothing and is dropped; re-creating the hook later starts fresh (re-sync via GET /mailboxes/{mailboxId}/messages/changes rather than expecting a backlog).

openemail.mailboxes.deleteEventWebhook(
  mailboxId: string,
  options?: CallOptions,
): ApiPromise<DeletedResult>

It calls DELETE /mailboxes/{mailboxId}/event-webhook: Remove the mailbox's event webhook in the API reference.

Example

const deletedResult = await openemail.mailboxes.deleteEventWebhook(mailboxId)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, DeletedResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404No hook configured, or mailbox not accessible
503temporary_failure — the mailbox’s creation is still installing its hook; retry after Retry-After

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: DeletedResult.