logo Windmill Hub
Login
Back to Zendesk integration
0

Search Macros

by
Published Nov 7, 2023

Search macros by title. Offset-paged (`page`, up to 100 per page).

Script zendesk Verified
Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 12 days ago
All edits
Permalink
1 
//native
2
3 
/**
4 
 * Search Macros
5 
 * Search macros by title. Offset-paged (`page`, up to 100 per page).
6 
 */
7 
export async function main(
8 
  auth: RT.Zendesk,
9 
  query: string,
10 
  page: number | undefined,
11 
  per_page: number | undefined
12 
) {
13 
  const url = new URL(
14 
    `https://${auth.subdomain}.zendesk.com/api/v2/macros/search`
15 
  )
16 
  url.searchParams.append("query", query)
17 
  url.searchParams.append("page", String(page || 1))
18 
  url.searchParams.append("per_page", String(per_page || 100))
19
20 
  const response = await fetch(url, {
21 
    headers: {
22 
      Authorization: auth.token
23 
        ? `Bearer ${auth.token}`
24 
        : `Basic ${btoa(`${auth.username}:${auth.password}`)}`,
25 
      Accept: "application/json",
26 
    },
27 
  })
28
29 
  if (!response.ok) {
30 
    throw new Error(`${response.status} ${await response.text()}`)
31 
  }
32
33 
  return await response.json()
34 
}
35
Other submissions
  • Submitted by hugo697 Typescript (fetch-only)
    Created 539 days ago
    All edits
    Permalink
    1 
    type Zendesk = {
    2 
      username: string;
    3 
      password: string;
    4 
      subdomain: string;
    5 
    };
    6 
    /**
    7 
     * Search Macros
    8 
     * #### Pagination
    9
    10 
    * Offset pagination only
    11
    12 
    See Using Offset Pagination.
    13
    14 
    #### Allowed For
    15 
    * Agents
    16
    17 
     */
    18 
    export async function main(
    19 
      auth: Zendesk,
    20 
      include: string | undefined,
    21 
      access: string | undefined,
    22 
      active: string | undefined,
    23 
      category: string | undefined,
    24 
      group_id: string | undefined,
    25 
      only_viewable: string | undefined,
    26 
      sort_by: string | undefined,
    27 
      sort_order: string | undefined,
    28 
      query: string | undefined
    29 
    ) {
    30 
      const url = new URL(
    31 
        `https://${auth.subdomain}.zendesk.com/api/v2/macros/search`
    32 
      );
    33 
      for (const [k, v] of [
    34 
        ["include", include],
    35 
        ["access", access],
    36 
        ["active", active],
    37 
        ["category", category],
    38 
        ["group_id", group_id],
    39 
        ["only_viewable", only_viewable],
    40 
        ["sort_by", sort_by],
    41 
        ["sort_order", sort_order],
    42 
        ["query", query],
    43 
      ]) {
    44 
        if (v !== undefined && v !== "") {
    45 
          url.searchParams.append(k, v);
    46 
        }
    47 
      }
    48 
      const response = await fetch(url, {
    49 
        method: "GET",
    50 
        headers: {
    51 
          Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
    52 
        },
    53 
        body: undefined,
    54 
      });
    55 
      if (!response.ok) {
    56 
        const text = await response.text();
    57 
        throw new Error(`${response.status} ${text}`);
    58 
      }
    59 
      return await response.json();
    60 
    }
    61