Class Webhooks

constructor

• new Webhooks(options?: SDKOptions): Webhooks

  Parameters

  • options: SDKOptions = {}

  Returns Webhooks

Readonly_baseURL

Readonly_hooks

Readonly_httpClient

Optional Readonly_logger

Readonly_options

_createRequest

• _createRequest(
      context: HookContext,
      conf: RequestConfig,
      options?: RequestOptions,
  ): Result<Request, UnexpectedClientError | InvalidRequestError>

  Parameters

  • context: HookContext
  • conf: RequestConfig
  • Optionaloptions: RequestOptions

  Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

• _do(
      request: Request,
      options: {
          context: HookContext;
          isErrorStatusCode: (statusCode: number) => boolean;
          retryCodes: string[];
          retryConfig: RetryConfig;
      },
  ): Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

  Parameters

  • request: Request
  • options: {
        context: HookContext;
        isErrorStatusCode: (statusCode: number) => boolean;
        retryCodes: string[];
        retryConfig: RetryConfig;
    }

  Returns Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

create

• create(
      params: CreateWebhookParams,
      options?: RequestOptions,
  ): APIPromise<Webhook>

  Creates a new Webhook.

  Parameters

  • params: CreateWebhookParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Webhook>

delete

• delete(
      id: string,
      params?: DeleteWebhookParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Empty>

  Deletes a Webhook.

  Parameters

  • id: string
  • Optionalparams: DeleteWebhookParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Empty>

get

• get(
      id: string,
      params?: GetWebhookParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<Webhook>

  Gets a specific Webhook.

  Parameters

  • id: string
  • Optionalparams: GetWebhookParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<Webhook>

list

• list(
      params?: ListWebhooksRequest,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<WebhookListResponse>

  Lists all Webhooks.

  Parameters

  • Optionalparams: ListWebhooksRequest
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<WebhookListResponse>

ping

• ping(
      id: string,
      api_version?: string,
      body?: PingWebhookRequest,
      options?: RequestOptions,
  ): APIPromise<WebhookPingResponse>

  Sends a ping event to a Webhook.

  Parameters

  • id: string
  • Optionalapi_version: string
  • Optionalbody: PingWebhookRequest
  • Optionaloptions: RequestOptions

  Returns APIPromise<WebhookPingResponse>

rotateSigningSecret

• rotateSigningSecret(
      id: string,
      api_version?: string,
      body?: RotateSigningSecretRequest,
      options?: RequestOptions,
  ): APIPromise<WebhookRotateSigningSecretResponse>

  Generates a new signing secret for a Webhook.

  Parameters

  • id: string
  • Optionalapi_version: string
  • Optionalbody: RotateSigningSecretRequest
  • Optionaloptions: RequestOptions

  Returns APIPromise<WebhookRotateSigningSecretResponse>

update

• update(
      id: string,
      params?: UpdateWebhookParams,
      options?: RequestOptions,
  ): APIPromise<Webhook>

  Updates an existing Webhook.

  Parameters

  • id: string
  • Optionalparams: UpdateWebhookParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<Webhook>