Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

Automation ID from GET /socials/automations.

Response

Automation

id
string
required
object
enum<string>
required
Available options:
social_automation
platform
enum<string>
required
Available options:
instagram,
facebook,
tiktok,
threads,
linkedin,
youtube
account_id
string
required

Connected account it runs on (sacct_ prefix id).

active
boolean
required

false pauses it.

name
string

Shown to the business in the Automations page.

trigger
enum<string>

comment (default): a comment on a post. story_reply: a reply to a story. story_mention: a story that mentions the account; send keywords: []. Every trigger but comment is Instagram only.

Available options:
comment,
live_comment,
story_reply,
story_mention
keywords
string[]

Words that fire it. An empty list fires on every comment.

match_mode
enum<string>

word matches the keyword as a whole word, contains anywhere ("app" fires on "happy"), exact only when the whole comment is the keyword. Defaults to contains; prefer word.

Available options:
word,
contains,
exact
exclude_keywords
string[]

Comments containing any of these never fire it.

dm_message
string

The private DM. Required on Instagram and Facebook; rejected on TikTok, Threads, LinkedIn and YouTube, which have no private reply. {{first_name}}, {{name}} and {{username}} are filled in. 640 characters at most when buttons are set.

buttons
object[]

Up to 3 link buttons under the DM. Send [] to remove them. Instagram may refuse buttons in a first DM to someone who does not follow the account, which spends that comment's one private reply: for cold audiences send plain text and the link after they answer.

Maximum array length: 3
comment_reply
string

Public reply under the comment, e.g. "Sent you a DM!". Required on TikTok, Threads, LinkedIn and YouTube, where it is the only action.

public_reply_policy
enum<string>

after_dm posts the public reply only once the DM went out.

Available options:
after_dm,
always
also_match_in_dms
boolean

Also answer a DM that contains a keyword. Needs at least one keyword. Use it for a printed QR code or sign: "scan, then send MENU".

dm_delay_seconds
integer

Wait this long before sending the DM, up to 86400.

audience
object

Who gets the DM. Instagram only.

follow_gate
object

The one-tap follow check sent when audience.when_unknown is verify.

repeat_policy
object

How often one person can trigger it. Defaults to once per person, ever.

platform_post_id
string | null

Only fire on this live post: the post's id from GET /socials/comments. Omit for every post; send null to unbind.

post_id
string | null

Only fire on this scheduled or published Crevio post (spost_ prefix id); it arms itself when the post goes live. Send null to unbind.

post_title
string | null

Snippet of the bound post, for display.

stats
object | null

Counters: triggered, dms_sent, dms_failed, unique_contacts, link_clicks, unique_clicks, audience_skipped, follow_gate_sent, follow_gate_passed.

created_at
string<date-time>