Class HeliusWebhookClient

constructor

• new HeliusWebhookClient(): HeliusWebhookClient

  Returns HeliusWebhookClient

Staticinstance

createWebhook

• createWebhook(
      params: CreateHeliusWebhookRequest,
  ): Promise<
      { ok: true; value: HeliusWebhook }
      | { error: HeliusError; ok: false },
  >

  err HELIUS_ERROR for a 4xx such as an invalid webhook request.

  Parameters

  • params: CreateHeliusWebhookRequest

  Returns Promise<{ ok: true; value: HeliusWebhook } | { error: HeliusError; ok: false }>

getAllWebhooks

• getAllWebhooks(): Promise<
      | { error: HeliusError; ok: false }
      | { ok: true; value: Omit<HeliusWebhook, "accountAddresses">[] },
  >

  Returns Promise<
      | { error: HeliusError; ok: false }
      | { ok: true; value: Omit<HeliusWebhook, "accountAddresses">[] },
  >

getWebhook

• getWebhook(webhookID: string): Promise<HeliusWebhook | null>

  The webhook, or null when it does not exist.

  Parameters

  • webhookID: string

  Returns Promise<HeliusWebhook | null>

updateWebhook

• updateWebhook(
      webhookID: string,
      params: UpdateHeliusWebhookRequest,
  ): Promise<
      | { ok: true; value: HeliusWebhook }
      | {
          error:
              | HeliusError
              | ServiceError<"WEBHOOK_NOT_FOUND", { webhookID: string }>;
          ok: false;
      },
  >

  err WEBHOOK_NOT_FOUND when the webhook does not exist, HELIUS_ERROR for any other 4xx.

  Parameters

  • webhookID: string
  • params: UpdateHeliusWebhookRequest

  Returns Promise<
      | { ok: true; value: HeliusWebhook }
      | {
          error:
              | HeliusError
              | ServiceError<"WEBHOOK_NOT_FOUND", { webhookID: string }>;
          ok: false;
      },
  >