Buttondown logo

Creating an automation

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/automations"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("POST", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "aut_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2000-01-01T00:00:00+00:00",
    "name": "Welcome email",
    "status": "inactive",
    "trigger": "subscriber.confirmed",
    "actions": [
        {
            "type": "send_email",
            "metadata": {
                "email_id": "em_0k28edc3fw896bp4mrhc535z5k"
            },
            "timing": {
                "time": "immediate",
                "delay": null
            }
        }
    ],
    "filters": {
        "filters": [],
        "groups": [],
        "predicate": "and"
    },
    "metadata": {},
    "should_evaluate_filter_after_delay": false
}

Body parameters

All parameters are optional unless explicitly specified.

name

Type
string · required
Description

The name of the automation.

trigger

Type
ExternalEventType
Description

The event that causes this automation to run.

actions

Type
[] · required
Description

The actions to perform when the trigger fires.

filters

Type
FilterGroup
Description

Conditions that must be met for the automation to run. Omit or pass null for no filter.

metadata

Type
object
Description

Additional metadata for the automation.

should_evaluate_filter_after_delay

Type
boolean
Description

If true, filters are re-evaluated after the delay has passed.