Snapvisor Docs
API ReferenceAutomations

Create an automation rule

Create an automation rule on a project. Requires administrator access to the project. Action targets must belong to the project's account. Use it when the user wants a project to react automatically to build events, for example by posting to Slack.

POST
/projects/{owner}/{project}/automation-rules

Create an automation rule on a project. Requires administrator access to the project. Action targets must belong to the project's account. Use it when the user wants a project to react automatically to build events, for example by posting to Slack.

Authorization

AuthorizationBearer <token>

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

In: header

Path Parameters

owner*string
Length1 <= length
project*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/projects/string/string/automation-rules" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "events": [      "build.completed"    ],    "actions": [      {        "type": "sendSlackMessage",        "payload": {          "name": "string"        }      }    ]  }'
{  "id": "string",  "name": "string",  "active": true,  "events": [    "build.completed"  ],  "conditions": [    {      "type": "build-branch",      "value": "string"    }  ],  "actions": [    {      "action": "string",      "actionPayload": {        "property1": null,        "property2": null      }    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

List a project's automation rules GET

List the automation rules of a project, most recent first. Requires administrator access to the project. Use it to see which actions, such as Slack messages, a project runs automatically on build events.

Get an automation rule GET

Retrieve a single automation rule. Requires administrator access to the project. Use it when you need the full definition of one rule, for example before changing it.