Retrieve a list of supported JavaScript functions

GET https://automation.8x8.com/api/v1/accounts/:accountId/steps/functions

Automation supports scripting in inputs, outputs and select next steps using JavaScript (supports most features of ECMAScript 2023). On top of standard functions, we have added some custom functions to make scripting easier for you. Use this resource to explore our custom functions.

Request

Path Parameters

    accountId stringrequired

    Account id

List of supported functions.

Schema

  • Array [
  • namestringrequired

    Name of the function.

    descriptionstringrequired

    Description of the function.

    examplestringrequired

    Example usage of the function.

    parameters object[]required

  • Array [
  • namestringrequired

    Name of the parameter

    typestringrequired

    Data type of the parameter

    requiredbooleanrequired

    Indicates whether the parameter is required when calling the function.

    defaultobject

    Default value of the parameter for optional parameters.

    descriptionstringrequired

    Description of the parameter.

    exampleobjectrequired

    Example value of the parameter.

  • ]
  • ]
[
{
"name":"string",
"description":"string",
"example":"string",
"parameters":[
{
"name":"string",
"type":"string",
"required":true,
"default":{},
"description":"string",
"example":{}
}
]
}
]
[
{
"name":"isDayOfWeek",
"description":"Checks if a date or timestamp falls on a given day of the week. Useful to design workflows that behaves differently on different days of the week (e.g., week vs weekend).",
"parameters":[
{
"name":"timestamp",
"type":"string",
"required":true,
"default":null,
"example":"2021-05-25",
"description":"Date or a timestamp. Standard date and datetime formats are supported."
},
{
"name":"day",
"type":"string",
"required":true,
"default":null,
"example":"Monday",
"description":"Day of the week (not case sensitive)."
}
],
"example":"isDayOfWeek('2021-05-25', 'Tuesday')"
}
]

Source: https://developer.8x8.com/connect/reference/get-functions · 8x8 CPaaS Developer Docs. Synced for support deflection.

Was this article helpful?
or
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.

Didn't find what you were looking for?

Submit a request