List Macro Action Definitions

Returns the definitions of the actions a macro can perform. For example, one action can set the status of a ticket. The definition of the action includes a title ("Status"), a type ("list"), and possible values. For a list of support actions, see Actions reference. #### Allowed For * Agents

Script zendesk Verified

by hugo697 ยท 11/7/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 377 days ago
1
type Zendesk = {
2
  username: string;
3
  password: string;
4
  subdomain: string;
5
};
6
/**
7
 * List Macro Action Definitions
8
 * Returns the definitions of the actions a macro can perform. For example,
9
one action can set the status of a ticket. The definition of the action
10
includes a title ("Status"), a type ("list"), and possible values. For a
11
list of support actions, see Actions reference.
12

13
#### Allowed For
14

15
* Agents
16

17
 */
18
export async function main(auth: Zendesk) {
19
  const url = new URL(
20
    `https://${auth.subdomain}.zendesk.com/api/v2/macros/definitions`
21
  );
22

23
  const response = await fetch(url, {
24
    method: "GET",
25
    headers: {
26
      Authorization: "Basic " + btoa(`${auth.username}:${auth.password}`),
27
    },
28
    body: undefined,
29
  });
30
  if (!response.ok) {
31
    const text = await response.text();
32
    throw new Error(`${response.status} ${text}`);
33
  }
34
  return await response.json();
35
}
36