Deployments
Deployments let the user schedule a job to deploy the contents of their workspace repository to their workspace in the Matatika cloud.
This can be done manually or via a GitHub Webhook which you can see how to set up in our Quick Start Guide: Workspace Deploy Hook
Requests
Deploy your workspace repository
POST
/api/workspaces/{workspaces-id}/deployments
Deploys the workspace {workspace-id}.
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/dd80b065-1419-4f1e-977a-87ede7535e53/deployments' -i -X POST \
-H 'Content-Type: application/json'
Python (requests)
import requests
url = "https://app.matatika.com/api/workspaces/dd80b065-1419-4f1e-977a-87ede7535e53/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" : "bca2aeda-6ed6-4c98-9414-b1a478476102",
"created" : "2025-05-02T08:54:11.75584",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@sit+prod",
"email" : "[email protected]"
}
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/jobs/bca2aeda-6ed6-4c98-9414-b1a478476102"
},
"delete job" : {
"href" : "https://app.matatika.com/api/jobs/bca2aeda-6ed6-4c98-9414-b1a478476102",
"type" : "DELETE"
},
"logs" : {
"href" : "https://app.matatika.com/api/jobs/bca2aeda-6ed6-4c98-9414-b1a478476102/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://app.matatika.com/api/jobs/bca2aeda-6ed6-4c98-9414-b1a478476102/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.
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/workspaces/dd80b065-1419-4f1e-977a-87ede7535e53/deployments/github-webhook' -i -X POST \
-H 'X-Hub-Signature: sha1=2c6781dd429744d282ac56903953888d0cc1e032' \
-H 'Content-Type: application/json' \
-d '{ }'
Python (requests)
import requests
url = "https://app.matatika.com/api/workspaces/dd80b065-1419-4f1e-977a-87ede7535e53/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" : "8ea547fc-8842-4dc1-a4ec-91af290e1ff2",
"created" : "2025-05-02T08:54:16.327151",
"type" : "WORKSPACE_DEPLOY",
"maxAttempts" : 0,
"attempt" : 0,
"status" : "QUEUED",
"_embedded" : {
"profile" : {
"id" : "auth0|5eb0327cbfd7490bff55feeb",
"name" : "[email protected]",
"handle" : "@sit+prod",
"email" : "[email protected]"
}
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/jobs/8ea547fc-8842-4dc1-a4ec-91af290e1ff2"
},
"delete job" : {
"href" : "https://app.matatika.com/api/jobs/8ea547fc-8842-4dc1-a4ec-91af290e1ff2",
"type" : "DELETE"
},
"logs" : {
"href" : "https://app.matatika.com/api/jobs/8ea547fc-8842-4dc1-a4ec-91af290e1ff2/logs?sequence=0",
"type" : "GET"
},
"withdraw job" : {
"href" : "https://app.matatika.com/api/jobs/8ea547fc-8842-4dc1-a4ec-91af290e1ff2/stopped",
"type" : "PUT"
}
}
}