Class ZapierNLAWrapper

A wrapper class for Zapier's Natural Language Actions (NLA). It provides an interface to interact with the 5k+ apps and 20k+ actions on Zapier's platform through a natural language API interface. This includes apps like Gmail, Salesforce, Trello, Slack, Asana, HubSpot, Google Sheets, Microsoft Teams, and many more.

Hierarchy

  • Serializable
    • ZapierNLAWrapper

Constructors

constructor

Properties

caller zapierNlaApiBase zapierNlaApiKey? zapierNlaOAuthAccessToken?

Methods

listActions listActionsAsString previewAction previewAsString runAction runAsString

Constructors

constructor

Properties

caller

caller: AsyncCaller

zapierNlaApiBase

zapierNlaApiBase: string = "https://nla.zapier.com/api/v1/"

Optional zapierNlaApiKey

zapierNlaApiKey?: string

Optional zapierNlaOAuthAccessToken

zapierNlaOAuthAccessToken?: string

Methods

listActions

  • Returns a list of all exposed (enabled) actions associated with current user (associated with the set api_key or access token).

    Returns Promise<ZapierValues[]>

listActionsAsString

  • Same as list, but returns a stringified version of the result.

    Returns Promise<string>

previewAction

  • Same as run, but instead of actually executing the action, will instead return a preview of params that have been guessed by the AI in case you need to explicitly review before executing.

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<ZapierValues>

previewAsString

  • Same as preview, but returns a stringified version of the result.

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<string>

runAction

  • Executes an action that is identified by action_id, must be exposed (enabled) by the current user (associated with the set api_key or access token).

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<ZapierValues>

runAsString

  • Same as run, but returns a stringified version of the result.

    Parameters

    • actionId: string
    • instructions: string
    • Optional params: ZapierValues

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc