Skip to main content

An Action is an operation that can be performed against a third-party API; either a read or a write. A Zap is composed of a read, followed by one or more writes.

​
id
string
required

The ID to refer to this action (unstable, may change when referenced app changes)

​
key
string
required

The developer provided identifier for this Action (stable)

​
app
required

Apps

​
type
enum<string>
required

The type of this object

  • action - action
Available options:
action
​
action_type
enum<string>
required

The type of this Action

  • READ - READ
  • READ_BULK - READ_BULK
  • WRITE - WRITE
  • SEARCH - SEARCH
  • SEARCH_OR_WRITE - SEARCH_OR_WRITE
  • SEARCH_AND_WRITE - SEARCH_AND_WRITE
  • FILTER - FILTER
Available options:
action
​
is_instant
boolean
required

Will be set to true if this Action triggers instantly. May only be true when type is READ.

​
title
string
required

The title of this Action.

​
description
string
required

A longer description of this Action, usually describing what it does in more detail.