Create an automation

A draft can be saved with errors, which issues lists; nothing runs until it is activated.

Errors

Status	`type`	`code`	When
403	`permission_denied`	`automations_not_enabled`	Where automations are not turned on.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Automations

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

name*string

The automation's name, 1 to 255 characters.

Length1 <= length <= 255

description?|

What the automation is for, up to 1,000 characters.

environment?|

The environment whose events and purchases the automation reacts to: production (the default) or test.

definition?|

The draft to start with; an empty flow to fill in when omitted.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/automations" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Welcome series",    "description": "Greets new users and nudges them after a day.",    "environment": "production",    "definition": {      "version": 1,      "trigger": {        "type": "person_signed_up",        "config": {},        "next": "welcome"      },      "nodes": [        {          "id": "welcome",          "type": "send_push",          "config": {            "title": "Hi {{ person.name | default: \\"there\\" }}",            "body": "Glad you\'re here."          },          "next": {            "out": "wait"          }        },        {          "id": "wait",          "type": "delay",          "config": {            "duration": {              "amount": 1,              "unit": "days"            }          },          "next": {            "out": "paid"          }        },        {          "id": "paid",          "type": "condition",          "config": {            "condition": {              "match": "all",              "rules": [                {                  "field": "person.entitlements",                  "operator": "contains",                  "value": "premium"                }              ]            }          },          "next": {            "no": "nudge"          }        },        {          "id": "nudge",          "type": "send_push",          "config": {            "title": "Still thinking?",            "body": "Your trial is waiting."          },          "next": {}        }      ],      "settings": {        "reentry": "once",        "exitOn": [          "$subscription.created"        ]      }    }  }'

{  "id": "auto_p4n8c2v6x0z3q7w1e5r9t2y6",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Welcome series",  "description": "Greets new users and nudges them after a day.",  "status": "draft",  "environment": "production",  "definition": {    "version": 1,    "trigger": {      "type": "person_signed_up",      "config": {},      "next": "welcome"    },    "nodes": [      {        "id": "welcome",        "type": "send_push",        "config": {          "title": "Hi {{ person.name | default: \"there\" }}",          "body": "Glad you're here."        },        "next": {          "out": "wait"        }      },      {        "id": "wait",        "type": "delay",        "config": {          "duration": {            "amount": 1,            "unit": "days"          }        },        "next": {          "out": "paid"        }      },      {        "id": "paid",        "type": "condition",        "config": {          "condition": {            "match": "all",            "rules": [              {                "field": "person.entitlements",                "operator": "contains",                "value": "premium"              }            ]          }        },        "next": {          "no": "nudge"        }      },      {        "id": "nudge",        "type": "send_push",        "config": {          "title": "Still thinking?",          "body": "Your trial is waiting."        },        "next": {}      }    ],    "settings": {      "reentry": "once",      "exitOn": [        "$subscription.created"      ]    }  },  "revision": 1,  "hasUnpublishedChanges": true,  "activeVersionId": null,  "triggerType": "person_signed_up",  "activatedAt": null,  "nextFireAt": null,  "createdAt": "2026-03-04T15:30:00.000Z",  "updatedAt": "2026-03-04T15:30:00.000Z",  "issues": []}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"name\"]"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "automations_not_enabled",    "message": "Automations are not enabled for this organization."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Errors

More in Automations

Create an automation

Errors

More in Automations

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create an automation

Create an automation

201application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`