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://app.matatika.com/api/workspaces/5649b0fc-6a7f-492f-87d0-05ea0b96edfa/deployments' -i -X POST \
-H 'Content-Type: application/json'
import requests
url = "https://app.matatika.com/api/workspaces/5649b0fc-6a7f-492f-87d0-05ea0b96edfa/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" : "249bc203-4d22-4d1d-968e-cf7f970fccc5",
"created" : "2026-04-23T13:10:36.667738",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "sit+prod@matatika.com",
"handle" : "@sit+prod",
"email" : "sit+prod@matatika.com"
}
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/jobs/249bc203-4d22-4d1d-968e-cf7f970fccc5"
},
"delete job" : {
"href" : "https://app.matatika.com/api/jobs/249bc203-4d22-4d1d-968e-cf7f970fccc5",
"type" : "DELETE"
},
"logs" : {
"href" : "https://app.matatika.com/api/jobs/249bc203-4d22-4d1d-968e-cf7f970fccc5/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://app.matatika.com/api/jobs/249bc203-4d22-4d1d-968e-cf7f970fccc5/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://app.matatika.com/api/workspaces/5649b0fc-6a7f-492f-87d0-05ea0b96edfa/deployments/github-webhook' -i -X POST \
-H 'X-Hub-Signature: sha1=fb70a9ec9ad31a114626fa2ec802d9eed4984c47' \
-H 'Content-Type: application/json' \
-d '{ }'
import requests
url = "https://app.matatika.com/api/workspaces/5649b0fc-6a7f-492f-87d0-05ea0b96edfa/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" : "a842429c-6f6b-4106-903b-78eb170228bb",
"created" : "2026-04-23T13:10:41.026887",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "sit+prod@matatika.com",
"handle" : "@sit+prod",
"email" : "sit+prod@matatika.com"
}
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/jobs/a842429c-6f6b-4106-903b-78eb170228bb"
},
"delete job" : {
"href" : "https://app.matatika.com/api/jobs/a842429c-6f6b-4106-903b-78eb170228bb",
"type" : "DELETE"
},
"logs" : {
"href" : "https://app.matatika.com/api/jobs/a842429c-6f6b-4106-903b-78eb170228bb/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://app.matatika.com/api/jobs/a842429c-6f6b-4106-903b-78eb170228bb/stopped",
"type" : "PUT"
}
}
}