Deployments
Deployments let the user schedule a job to deploy the contents of their workspace repository to their workspace in Meltano Cloud.
This can be done manually or via a GitHub repository webhook:
- Payload URL:
https://app.meltano.com/api/workspaces/<workspace_id>/deployments/github-webhook - Content type:
application/json - Secret: "Deployment Secret" from workspace settings in Meltano Cloud
Requests
Deploy your workspace repository
POST /api/workspaces/{workspaces-id}/deployments
Deploys the workspace {workspace-id}.
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/d2f248f4-fe42-4e12-82db-e90271de63cc/deployments' -i -X POST \
-H 'Content-Type: application/json'
import requests
url = "https://staging.meltano.com:443/api/workspaces/d2f248f4-fe42-4e12-82db-e90271de63cc/deployments"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
202 Accepted
Job with HAL links.
{
"id" : "40c33098-a996-429d-8f2f-02cb2cafedd7",
"created" : "2026-07-13T16:12:11.381005",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|6a205ea86a76a69d8a3babcb",
"name" : "sit@meltano.com",
"handle" : "@sit1",
"email" : "sit@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "auth0|6a205ea86a76a69d8a3babcb"
}
}
},
"_links" : {
"self" : {
"href" : "https://staging.meltano.com/api/jobs/40c33098-a996-429d-8f2f-02cb2cafedd7"
},
"delete job" : {
"href" : "https://staging.meltano.com/api/jobs/40c33098-a996-429d-8f2f-02cb2cafedd7",
"type" : "DELETE"
},
"logs" : {
"href" : "https://staging.meltano.com/api/jobs/40c33098-a996-429d-8f2f-02cb2cafedd7/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://staging.meltano.com/api/jobs/40c33098-a996-429d-8f2f-02cb2cafedd7/stopped",
"type" : "PUT"
}
}
}
GitHub webhook workspace deployment
POST /api/workspaces/{workspaces-id}/deployments/github-webhook
Receives POST requests from GitHub and starts a workspace deploy job.
Examples
- cURL
- Python (requests)
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/d2f248f4-fe42-4e12-82db-e90271de63cc/deployments/github-webhook' -i -X POST \
-H 'X-Hub-Signature: sha1=2bc7f41b93233e1062555b4fb85d4e6a700b67a6' \
-H 'Content-Type: application/json' \
-d '{ }'
import requests
url = "https://staging.meltano.com:443/api/workspaces/d2f248f4-fe42-4e12-82db-e90271de63cc/deployments/github-webhook"
data = { }
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
202 Accepted
Job with HAL links.
{
"id" : "3b17de3c-7cfd-4489-b8c3-feea442ae11f",
"created" : "2026-07-13T16:12:24.136494",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|6a205ea86a76a69d8a3babcb",
"name" : "sit@meltano.com",
"handle" : "@sit1",
"email" : "sit@meltano.com",
"workingAccount" : {
"company" : "Test Company",
"id" : "auth0|6a205ea86a76a69d8a3babcb"
}
}
},
"_links" : {
"self" : {
"href" : "https://staging.meltano.com/api/jobs/3b17de3c-7cfd-4489-b8c3-feea442ae11f"
},
"delete job" : {
"href" : "https://staging.meltano.com/api/jobs/3b17de3c-7cfd-4489-b8c3-feea442ae11f",
"type" : "DELETE"
},
"logs" : {
"href" : "https://staging.meltano.com/api/jobs/3b17de3c-7cfd-4489-b8c3-feea442ae11f/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://staging.meltano.com/api/jobs/3b17de3c-7cfd-4489-b8c3-feea442ae11f/stopped",
"type" : "PUT"
}
}
}