Function getWebhooks

Parameters

• query: {
      createdByUserId?: string;
      enabled?: boolean;
      eventTypes?: string;
      level?: string;
      limit?: number;
      name?: string;
      next?: string;
      origins?: "api" | "automations" | "management-console";
      ownerId?: string;
      prev?: string;
      sort?:
          | "url"
          | "name"
          | "-name"
          | "+name"
          | "+createdAt"
          | "-createdAt"
          | "+updatedAt"
          | "-updatedAt"
          | "createdAt"
          | "updatedAt"
          | "+url"
          | "-url";
      updatedByUserId?: string;
      url?: string;
  }

  an object with query parameters

  • OptionalcreatedByUserId?: string

    Filter resources by user that created it.

  • Optionalenabled?: boolean

    Filter resources by enabled true/false.

  • OptionaleventTypes?: string

    Filter resources by event-type/types, a single webhook item can have multiple event-types.

  • Optionallevel?: string

    Filter resources by level that user has access to (either user or level).

  • Optionallimit?: number

    Maximum number of webhooks to retrieve.

  • Optionalname?: string

    Filter resources by name (wildcard and case insensitive).

  • Optionalnext?: string

    Cursor to the next page.

  • Optionalorigins?: "api" | "automations" | "management-console"

    Filter resources by origins, supports multiorigin.

  • OptionalownerId?: string

    Filter resources by user that owns it, only applicable for user level webhooks.

  • Optionalprev?: string

    Cursor to the previous page.

  • Optionalsort?:
        | "url"
        | "name"
        | "-name"
        | "+name"
        | "+createdAt"
        | "-createdAt"
        | "+updatedAt"
        | "-updatedAt"
        | "createdAt"
        | "updatedAt"
        | "+url"
        | "-url"

    Field to sort by, prefix with -/+ to indicate order.

  • OptionalupdatedByUserId?: string

    Filter resources by user that last updated the webhook.

  • Optionalurl?: string

    Filter resources by URL (wildcard and case insensitive).

• Optionaloptions: ApiCallOptions