Skip to main content
POST
/
orgs
/
{org_id}
/
assistants
/
{assistant_id}
/
actions
Create Assistant Action
curl --request POST \
  --url https://api.useinvent.com/orgs/{org_id}/assistants/{assistant_id}/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "action_id": "SCHEDULER:TIMEZONES_LIST",
  "config": {
    "input": {},
    "definitions": [
      {
        "path": "<string>",
        "definition": {}
      }
    ]
  },
  "name": "<string>",
  "instructions": "<string>",
  "connection_id": "<string>"
}
'
{
  "id": "<string>",
  "enabled": true,
  "name": "<string>",
  "instructions": "<string>",
  "action_id": "<string>",
  "assistant_id": "<string>",
  "connection_id": "<string>",
  "config": {
    "input": {},
    "definitions": [
      {
        "path": "<string>",
        "definition": {}
      }
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

assistant_id
string
required

The ID of the assistant

Body

The assistant action information.

Schema for creating a new assistant action

enabled
boolean
required
action_id
enum<string>
required
Available options:
SCHEDULER:TIMEZONES_LIST,
SCHEDULER:ON_SCHEDULE,
WORKFLOWS:CALL_WORKFLOW,
WORKFLOWS:WORKFLOW_ACTIONS,
TOOLS:HTTP_REQUEST,
TOOLS:WEB_SEARCH,
TOOLS:WEB_SCRAPING,
TOOLS:KB_SEARCH,
FILES:DOWNLOAD_FILE,
FILES:UPLOAD_FILE,
FILES:DELETE_FILE,
FILES:MARKDOWN_TO_PDF,
FILES:HTML_TO_PDF,
AUDIENCE:GET_SEGMENTS,
AUDIENCE:UPDATE_SEGMENTS,
AUDIENCE:UPDATE_CONTACT_SEGMENTS,
AUDIENCE:SEGMENTS_LIST,
AUDIENCE:CONTACTS_LIST,
EMAILS:SEND_EMAIL,
EMAILS:ON_EMAIL_STATUS_CHANGE,
MCP:TOOL_SCHEMA,
MCP:TOOL_CALL,
GOOGLE_SHEETS:ON_SPREADSHEETS_NEW_ROW,
GOOGLE_SHEETS:SPREADSHEETS_LIST,
GOOGLE_SHEETS:SPREADSHEETS_FILES_LIST,
GOOGLE_SHEETS:SPREADSHEETS_APPEND_ROW,
GOOGLE_SHEETS:SPREADSHEETS_UPDATE_ROW,
GOOGLE_SHEETS:SPREADSHEETS_SEARCH,
GOOGLE_SHEETS:WORKSHEETS_LIST,
GOOGLE_CALENDAR:ON_NEW_EVENT,
GOOGLE_CALENDAR:CALENDARS_LIST,
GOOGLE_CALENDAR:EVENTS_SEARCH,
GOOGLE_CALENDAR:EVENTS_GET,
GOOGLE_CALENDAR:EVENTS_CREATE,
GOOGLE_CALENDAR:EVENTS_UPDATE,
GOOGLE_CALENDAR:EVENTS_DELETE,
GOOGLE_CALENDAR:EVENTS_QUICK_ADD,
GOOGLE_CALENDAR:FREEBUSY_QUERY,
GOOGLE_DRIVE:FILES_LIST,
GOOGLE_DRIVE:FILES_GET,
GOOGLE_DRIVE:FILES_SEARCH,
GOOGLE_DRIVE:FILES_DOWNLOAD,
GOOGLE_DRIVE:FILES_CREATE,
GOOGLE_DRIVE:FILES_UPDATE,
GOOGLE_DRIVE:FILES_DELETE,
GOOGLE_DRIVE:FOLDERS_CREATE,
AIRTABLE:BASES_LIST,
AIRTABLE:TABLES_LIST,
AIRTABLE:TABLE_SCHEMA,
AIRTABLE:RECORD_CREATE,
AIRTABLE:RECORD_UPDATE,
AIRTABLE:RECORD_GET,
AIRTABLE:RECORD_DELETE,
AIRTABLE:RECORDS_SEARCH,
AIRTABLE:COLLABORATORS_LIST,
NOTION:DATA_SOURCES_LIST,
NOTION:DATA_SOURCE_SCHEMA,
NOTION:PAGES_SEARCH,
NOTION:USERS_LIST,
NOTION:PAGES_AND_RECORDS_LIST,
NOTION:RECORD_CREATE,
NOTION:RECORD_UPDATE,
NOTION:RECORD_GET,
NOTION:RECORDS_SEARCH,
NOTION:PAGE_CREATE,
NOTION:PAGE_GET,
NOTION:PAGE_UPDATE,
NOTION:PAGE_CONTENT_APPEND,
NOTION:COMMENT_CREATE,
NOTION:COMMENTS_LIST,
NOTION:SEARCH,
LINEAR:TEAMS_LIST,
LINEAR:STATES_LIST,
LINEAR:USERS_LIST,
LINEAR:ISSUE_CREATE,
LINEAR:ISSUE_UPDATE,
LINEAR:ISSUE_GET,
LINEAR:ISSUES_SEARCH,
LINEAR:ISSUE_COMMENT_CREATE,
LINEAR:LABELS_LIST,
TRELLO:BOARDS_LIST,
TRELLO:BOARD_GET,
TRELLO:LISTS_LIST,
TRELLO:CARDS_SEARCH,
TRELLO:CARD_CREATE,
TRELLO:CARD_UPDATE,
TRELLO:CARD_GET,
TRELLO:CARD_MOVE,
TRELLO:CARD_COMMENT,
TRELLO:CARD_DELETE,
TRELLO:MEMBERS_LIST,
TRELLO:LABELS_LIST,
HUBSPOT:CONTACTS_SEARCH,
HUBSPOT:CONTACT_CREATE,
HUBSPOT:CONTACT_UPDATE,
HUBSPOT:CONTACT_GET,
HUBSPOT:CONTACT_PROPERTIES_LIST,
HUBSPOT:COMPANIES_SEARCH,
HUBSPOT:COMPANY_CREATE,
HUBSPOT:COMPANY_UPDATE,
HUBSPOT:COMPANY_GET,
HUBSPOT:COMPANY_PROPERTIES_LIST,
HUBSPOT:DEALS_SEARCH,
HUBSPOT:DEAL_CREATE,
HUBSPOT:DEAL_UPDATE,
HUBSPOT:DEAL_GET,
HUBSPOT:DEAL_PROPERTIES_LIST,
SALESFORCE:OBJECTS_LIST,
SALESFORCE:LEADS_SEARCH,
SALESFORCE:LEAD_GET,
SALESFORCE:LEAD_CREATE,
SALESFORCE:LEAD_UPDATE,
SALESFORCE:LEAD_DELETE,
SALESFORCE:CONTACTS_SEARCH,
SALESFORCE:CONTACT_GET,
SALESFORCE:CONTACT_CREATE,
SALESFORCE:CONTACT_UPDATE,
SALESFORCE:CONTACT_DELETE,
SALESFORCE:ACCOUNTS_SEARCH,
SALESFORCE:ACCOUNT_GET,
SALESFORCE:ACCOUNT_CREATE,
SALESFORCE:ACCOUNT_UPDATE,
SALESFORCE:ACCOUNT_DELETE,
SALESFORCE:OPPORTUNITIES_SEARCH,
SALESFORCE:OPPORTUNITY_GET,
SALESFORCE:OPPORTUNITY_CREATE,
SALESFORCE:OPPORTUNITY_UPDATE,
SALESFORCE:OPPORTUNITY_DELETE,
ZOHO:MODULES_LIST,
ZOHO:MODULE_FIELDS,
ZOHO:RECORD_GET,
ZOHO:RECORD_CREATE,
ZOHO:RECORD_UPDATE,
ZOHO:RECORD_DELETE,
ZOHO:RECORDS_SEARCH,
GOHIGHLEVEL:CONTACTS_SEARCH,
GOHIGHLEVEL:CONTACT_GET,
GOHIGHLEVEL:CONTACT_CREATE,
GOHIGHLEVEL:CONTACT_UPDATE,
GOHIGHLEVEL:CONTACT_DELETE,
GOHIGHLEVEL:CONTACT_TAGS_ADD,
GOHIGHLEVEL:CONTACT_TAGS_REMOVE,
GOHIGHLEVEL:OPPORTUNITIES_SEARCH,
GOHIGHLEVEL:OPPORTUNITY_GET,
GOHIGHLEVEL:OPPORTUNITY_CREATE,
GOHIGHLEVEL:OPPORTUNITY_UPDATE,
GOHIGHLEVEL:OPPORTUNITY_DELETE,
GOHIGHLEVEL:PIPELINES_LIST,
GOHIGHLEVEL:PIPELINE_STAGES_LIST,
GOHIGHLEVEL:CALENDARS_LIST,
GOHIGHLEVEL:CALENDAR_EVENTS_LIST,
GOHIGHLEVEL:CALENDAR_FREE_SLOTS,
GOHIGHLEVEL:CALENDAR_BLOCKED_SLOTS,
GOHIGHLEVEL:CALENDAR_EVENT_CREATE,
GOHIGHLEVEL:CALENDAR_EVENT_UPDATE,
GOHIGHLEVEL:CALENDAR_EVENT_DELETE,
GOHIGHLEVEL:CAMPAIGNS_LIST,
GOHIGHLEVEL:TAGS_LIST,
GOHIGHLEVEL:COUNTRIES_LIST,
GOHIGHLEVEL:CUSTOM_FIELDS,
GOHIGHLEVEL:USERS_LIST,
CAL:BOOKINGS_LIST,
CAL:BOOKING_GET,
CAL:BOOKING_CREATE,
CAL:BOOKING_UPDATE,
CAL:BOOKING_CANCEL,
CAL:EVENTS_LIST,
CAL:SLOTS_GET,
CALENDLY:EVENTS_SEARCH,
CALENDLY:EVENT_GET,
CALENDLY:EVENT_CANCEL,
CALENDLY:EVENT_TYPES_LIST,
CALENDLY:USERS_LIST,
CALENDLY:SCHEDULING_LINK_CREATE,
CALENDLY:EVENT_CREATE,
CALENDLY:AVAILABLE_TIMES_GET,
SLACK:ON_MENTION,
SLACK:ON_CHANNEL_NEW_MESSAGE,
SLACK:CHANNELS_LIST,
SLACK:CHANNELS_LIST_WITH_ANY,
SLACK:CHANNELS_MESSAGES_LIST,
SLACK:SEARCH,
SLACK:CHANNELS_SEND_MESSAGE,
SLACK:CHANNELS_REPLY_MESSAGE,
TELEGRAM:ON_NEW_MESSAGE,
TELEGRAM:SEND_MESSAGE,
INSTAGRAM:ON_NEW_MESSAGE,
INSTAGRAM:SEND_MESSAGE,
MESSENGER:ON_NEW_MESSAGE,
MESSENGER:SEND_MESSAGE,
MESSENGER:PAGES_LIST,
WHATSAPP:ON_NEW_MESSAGE,
WHATSAPP:ON_MESSAGE_STATUS_CHANGE,
WHATSAPP:SEND_MESSAGE,
WHATSAPP:SEND_MESSAGE_TEMPLATE,
WHATSAPP:PHONE_NUMBERS_LIST,
WHATSAPP:TEMPLATES_LIST,
GMAIL:ON_NEW_EMAIL,
GMAIL:SEND_EMAIL,
GMAIL:REPLY_EMAIL,
GMAIL:FROM_EMAIL_LIST,
GMAIL:LABELS_LIST,
JAPIFON:ON_NEW_MESSAGE,
JAPIFON:MESSAGE_SEND,
TWILIO:ON_NEW_MESSAGE,
TWILIO:SEND_MESSAGE,
TWILIO:PHONE_NUMBERS_LIST,
TELNYX:ON_NEW_MESSAGE,
TELNYX:SEND_MESSAGE,
TELNYX:PHONE_NUMBERS_LIST,
RESEND:ON_NEW_EMAIL,
RESEND:SEND_EMAIL,
STRIPE:CUSTOMER_CREATE,
STRIPE:CUSTOMER_GET,
STRIPE:CUSTOMER_UPDATE,
STRIPE:CUSTOMERS_SEARCH,
STRIPE:CURRENCIES_LIST,
STRIPE:PRICES_LIST,
STRIPE:PAYMENT_GET,
STRIPE:PAYMENT_REFUND,
STRIPE:PAYMENTS_LIST,
STRIPE:SUBSCRIPTION_CREATE,
STRIPE:SUBSCRIPTION_GET,
STRIPE:SUBSCRIPTION_UPDATE,
STRIPE:SUBSCRIPTION_CANCEL,
STRIPE:SUBSCRIPTIONS_LIST,
STRIPE:INVOICE_CREATE,
STRIPE:INVOICE_GET,
STRIPE:INVOICE_SEND,
STRIPE:INVOICES_LIST,
STRIPE:CHECKOUT_SESSION_CREATE,
STRIPE:BILLING_PORTAL_SESSION_CREATE,
STRIPE:PAYMENT_LINK_CREATE,
STRIPE:PAYMENT_LINK_GET,
SHOPIFY:PRODUCTS_SEARCH,
SHOPIFY:PRODUCT_GET,
SHOPIFY:ORDERS_SEARCH,
SHOPIFY:ORDER_GET,
SHOPIFY:ORDER_UPDATE,
SHOPIFY:CUSTOMERS_SEARCH,
SHOPIFY:CUSTOMER_GET,
SHOPIFY:CUSTOMER_CREATE,
SHOPIFY:CUSTOMER_UPDATE,
SHOPIFY:PRODUCT_VARIANTS_SEARCH,
SHOPIFY:ORDER_CREATE,
SHOPIFY:INVENTORY_LEVELS_LIST,
ZENDESK:TICKET_SEARCH,
ZENDESK:TICKET_CREATE,
ZENDESK:TICKET_GET,
ZENDESK:TICKET_UPDATE,
ZENDESK:TICKET_REPLY,
ZENDESK:TICKET_ADD_NOTE,
ZENDESK:TICKET_COMMENTS_LIST,
ZENDESK:TICKETS_LIST,
ODOO:LEADS_SEARCH,
ODOO:LEAD_GET,
ODOO:LEAD_CREATE,
ODOO:LEAD_UPDATE,
ODOO:LEAD_DELETE,
ODOO:LEAD_CONVERT,
ODOO:OPPORTUNITIES_SEARCH,
ODOO:OPPORTUNITY_GET,
ODOO:OPPORTUNITY_CREATE,
ODOO:OPPORTUNITY_UPDATE,
ODOO:OPPORTUNITY_DELETE,
ODOO:STAGES_LIST,
ODOO:CONTACTS_SEARCH,
ODOO:CALENDARS_LIST,
ODOO:CALENDAR_EVENTS_LIST,
ODOO:CALENDAR_EVENT_CREATE,
ODOO:CALENDAR_EVENT_UPDATE,
ODOO:CALENDAR_EVENT_DELETE
config
object
required

The input values with their dynamic field definitions

name
string

The name of the action, e.g. "Send email"

Maximum string length: 64
instructions
string

Extra instructions for the action

Maximum string length: 2048
connection_id
string

The ID of the connection to use for the action if required, e.g. "con_XXX"

Example:

"con_XXX"

Response

200 - application/json

The created assistant action.

Schema for an assistant action

id
string
required

The ID of the action

enabled
boolean
required

Whether the action is enabled

name
string | null
required

The name of the action

instructions
string | null
required

The instructions for the action

action_id
string
required

The ID of the action, e.g. "TOOLS:HTTP_REQUEST"

Examples:

"TOOLS:HTTP_REQUEST"

"TOOLS:WEB_SEARCH"

"TOOLS:WEB_SCRAPING"

assistant_id
string
required

The ID of the assistant

Example:

"ast_XXX"

connection_id
string | null
required

The ID of the connection to use for the action if required

Example:

"con_XXX"

config
object
required

The input values with their dynamic field definitions

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required