CircleCI

Continuous integration and delivery for any platform

 ⚙
 Setup
You will need two keys to Interact with the CircleCI module:
Circle Token 
API Key 
More information on these these keys can be found here.

🤖
 Modes
​💎
 Get all Pipelines 

 📥
 Inputs
Project Path (Required) -  Project slug in the form vcs-slug/org-name/repo-name      Example: gh/CircleCI-Public/api-preview-docs
Project Branch ( Optional ) -  The name of a vcs branch.
Page Token ( Optional ) - A token to retrieve the next page of results.
​ 📤
 Output
1
all_pipeline_details = {
2
    "items": [ {
3
        "id" : String,
4
        "errors": [ {
5
            "type"       : String,
6
            "message"    : String,
7
            } ],
8
        "project_slug"   : String,
9
        "updated_at"     : Datetime,
10
        "number"         : Int,
11
        "state"          : String,
12
        "created_at"     : Datetime,
13
        "trigger" : {
14
        "type"           : String,
15
        "received_at"    : Datetime,
16
        "actor"          : {
17
            "login"      : String,
18
            "avatar_url" : String
19
            }
20
        },
21
        "vcs": {
22
            "provider_name": String,
23
            "target_repository_url": URL,
24
            "branch": String,
25
            "review_id": Int,
26
            "review_url": String,
27
            "revision": String,
28
            "tag": String,
29
            "commit": {
30
                "subject": String,
31
                "body": String
32
        },
33
        "origin_repository_url": URL
34
        }
35
    } ],
36
    "next_page_token": "string"
37
}
Copied!
​🔨
 Trigger a Pipeline
 📥
 Inputs
Project Path (Required) -  Project slug in the form vcs-slug/org-name/repo-name      Example: gh/CircleCI-Public/api-preview-docs
Project Branch ( Optional ) -  The name of a vcs branch.
X Attribution Login - The login or user-readable identifier for the pipeline's triggerer.
X Attribution Actor ID - The id the integration uses to identify the pipeline's triggerer.
​ 📤
 Output
1
created_pipeline = {
2
    "id"            : String,
3
    "state"         : String,
4
    "number"        : 0,
5
    "created_at"    : Datetime
6
}
Copied!
​📌
 Approve a Workflow Job
​📥
 Inputs
Job Approval Request ID -  The ID of the job being approved. 
Job ID -  The unique ID of the workflow.
​ 📤
 Output
1
job_approval_response = {
2
    "message": String
3
}
Copied!