Skip to main content
GET
Retrieve an automation

Authorizations

Authorization
string
header
required

API key created in the Agentova app (Settings → API), sent as Authorization: Bearer agk_live_…. One key = one workspace: the key determines the workspace, and no workspace identifier ever travels in requests. The Bearer scheme is case-insensitive. A revoked key is refused immediately.

Path Parameters

id
string
required

Opaque aut_… identifier, as returned by the API.

Response

The automation

An automation of the workspace, carried out by one agent.

id
string
required

Opaque identifier prefixed with aut_. Stable for a given automation.

name
string
required

Display label in English: what the automation does, then the agent's name (for example Comment replies — Support Agent, or HubSpot contacts — Support Agent for a CRM source). For display only: it can change, and two automations can share one.

type
enum<string>
required

social_comments, social_story and lead_ads cover the Meta networks (Facebook, Instagram). social_messages replies to private messages on the Meta networks and on WhatsApp (the provider field tells them apart). email_messages replies to the e-mails of a Gmail, Outlook or IMAP mailbox. crm_source is an automation triggered by a CRM.

Available options:
social_comments,
social_story,
social_messages,
lead_ads,
email_messages,
crm_source
provider
string
required

The connected service, as a raw value. Messaging automations: facebook, instagram, instagram_page, whatsapp, gmail, microsoft_outlook, imap. CRM sources carry the name of the CRM (for example hubspot). Treat it as an open string: new values can appear.

agent_id
string
required

Opaque identifier of the agent, prefixed with agt_.

agent_name
string
required

Name of the agent.

status
enum<string>
required
  • active: running.
  • paused: paused from the Agentova app or through PATCH.
  • draft: never activated; it has to be activated from the Agentova app.
  • error: stopped by a failure that has to be fixed from the Agentova app (for example a lost e-mail connection, a channel that could not be reconnected on resume, or a subscription to the provider that could not be renewed).

PATCH only acts on active and paused automations.

An automation that is deleted or deactivated in the Agentova app, or whose connected account is disconnected, is no longer returned by the API (404 automation_not_found). When a failure is what removes it (revoked token, mailbox authentication refused, reconnection impossible), a last automation.status_changed event is sent first, with status: error. When the account is reconnected, an automation.status_changed event with status: active is sent for each automation that comes back. A deliberate deletion sends no event.

Available options:
active,
paused,
draft,
error
updated_at
string<date-time>
required

Date of the last change to the automation. Use it to order automation.status_changed events.