Validate an automation

A dry run. Checks a proposed comment-to-DM automation against the rules the engine enforces and returns the normalised version together with anything that would make it misfire: a keyword with a space in it, a button label Instagram would cut off, a DM that promises a link it was never given.

It writes nothing, needs no post, and works with a read key, so you can check copy before you have anywhere to put it.

Needs a read or full key.

POST /automations/validate

Validate an automation

cURL

curl --request POST \
  --url https://api.indm.social/v1/automations/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "keyword": "GUIDE",
  "dm_message": "Here's the spring planting guide. Enjoy it."
}
EOF

200

{
  "specification": {
    "trigger": "comment",
    "keyword": "GUIDE",
    "public_reply": "<string>",
    "button_label": "Send me the guide",
    "dm_message": "Here's the spring planting guide. Enjoy it.",
    "link_url": "https://example.com/spring-guide",
    "language": "en",
    "status_when_created": "draft"
  },
  "ready": true,
  "problems": [],
  "notes": [
    {
      "code": "keywords_case_insensitive",
      "message": "Keywords are case-insensitive, so GUIDE also matches guide and Guide."
    },
    {
      "code": "created_as_draft",
      "message": "Created as a draft. Nothing sends until it is set live."
    }
  ]
}

Authorizations

Authorization · string · header · required

An API key from Settings → API keys in the inDM app, sent as Authorization: Bearer indm_.... Keys belong to one workspace and carry a scope: read for GET routes and the validate dry run, full for everything. Keep keys on your server; never ship one to a browser or a mobile app.

Body

application/json

A proposed automation to check. Nothing is saved.

keyword · string · required

The one word a fan comments to trigger it. Case-insensitive.

Example:

"GUIDE"

dm_message · string · required

The direct message the fan receives.

Example:

"Here's the spring planting guide. Enjoy it."

goal · string

What you want to happen, in your own words.

Example:

"Send the spring guide to anyone who comments GUIDE"

button_label · string

The opt-in button's label. Up to 20 characters.

Example:

"Send me the guide"

public_reply · string

A public reply posted under the fan's comment.

link_url · string

The link the DM delivers.

Example:

"https://example.com/spring-guide"

language · string

The two-letter code of the language the copy is written in, such as en, es or ko.

Example:

"en"

Response

200

application/json

The check. ready is true when nothing would stop it working.

specification · object · required

The normalised automation, as inDM would build it.

Show child attributes

ready · boolean · required

True when problems is empty, so nothing would stop it working.

Example:

true

problems · object[] · required

What would make it misfire, in the order found. Empty when ready is true.

Show child attributes

Example:

[]

notes · object[] · required

Facts about how it will behave once live.

Show child attributes

Example:

[
  {
    "code": "keywords_case_insensitive",
    "message": "Keywords are case-insensitive, so GUIDE also matches guide and Guide."
  },
  {
    "code": "created_as_draft",
    "message": "Created as a draft. Nothing sends until it is set live."
  }
]