Function getWebhooks

  • Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the TenantAdmin role can retrieve all webhooks. A user can have up to 150 webhooks at one time.

    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
      • OptionaleventTypes?: string
      • Optionallevel?: string
      • Optionallimit?: number
      • Optionalname?: string
      • Optionalnext?: string
      • Optionalorigins?: "api" | "automations" | "management-console"
      • OptionalownerId?: string
      • Optionalprev?: string
      • Optionalsort?:
            | "url"
            | "name"
            | "-name"
            | "+name"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "createdAt"
            | "updatedAt"
            | "+url"
            | "-url"
      • OptionalupdatedByUserId?: string
      • Optionalurl?: string
    • Optionaloptions: ApiCallOptions

    Returns Promise<GetWebhooksHttpResponse>

    GetWebhooksHttpError