Apps

get
Get Apps

https://api.appmixer.com/apps
Returns all applications (services or modules) available. curl "https://api.appmixer.com/apps" -H "Authorization: Bearer [ACCESS_TOKEN]"
Request
Response
Request
Response
200: OK
Cake successfully retrieved.
{
"appmixer.asana": {
"name": "appmixer.asana",
"label": "Asana",
"category": "applications",
"description": "Asana is a collaborative information manager for workspace. It helps you organize people and tasks effectively.",
"icon": "data:image/png;base64,iVBORw0KGgoA....kJggg=="
},
"appmixer.calendly": {
"name": "appmixer.calendly",
"label": "Calendly",
"category": "applications",
"description": "Calendly helps you schedule meetings without the back-and-forth emails. It does not work with the free Basic account. It works with Premium or Pro account.",
"icon": "data:image/png;base64,iVBORw0KGgoA....kJggg=="
},
"appmixer.clearbit": {
"name": "appmixer.clearbit",
"label": "Clearbit",
"category": "applications",
"description": "Clearbit is a data API that lets you enrich your person and company records with social, demographic, and firmographic data.",
"icon": "data:image/png;base64,iVBORw0KGgoA....kSuQmCC"
},
"appmixer.dropbox": {
"name": "appmixer.dropbox",
"label": "Dropbox",
"category": "applications",
"description": "Dropbox is a home for all your photos, documents, videos, and other files. Dropbox lets you access your stuff from anywhere and makes it easy to share with others.",
"icon": "data:image/svg+xml;base64,PHN2Z....3N2Zz4="
},
"appmixer.evernote": {
"name": "appmixer.evernote",
"label": "Evernote",
"category": "applications",
"description": "Evernote is a powerful note taking application that makes it easy to capture ideas, images, contacts, and anything else you need to remember. Bring your life's work together in one digital workspace, available on all major mobile platforms and devices.",
"icon": "data:image/png;base64,iVBORw0KGgoA....kSuQmCC"
}
}

get
Get App Components

https://api.appmixer.com/apps/components
Returns all components of an app including their manifest files. curl "https://api.appmixer.com/apps/components?app=appmixer.dropbox" -H "Authorization: Bearer [ACCESS_TOKEN]"
Request
Response
Request
Path Parameters
app
required
string
ID of an app as defined in service.json or module.json.
Response
200: OK
[
{
"name": "appmixer.twilio.sms.SendSMS",
"author": "David Durman <david@client.io>",
"icon": "data:image/png;base64,iVBORw...gg==",
"description": "Send SMS text message through Twilio.",
"auth": { "service": "appmixer:twilio" },
"inPorts": [
{
"name": "message",
"schema": {
"type": "object",
"properties": {
"body": { "type": "string" },
"to": { "type": "string" }
},
"required": [ "to" ]
},
"inspector": {
"inputs": {
"body": {
"type": "text",
"label": "Text message",
"tooltip": "Text message that should be sent.",
"index": 1
},
"to": {
"type": "text",
"label": "To number",
"tooltip": "The destination phone number. <br/><br/>Format with a '+' and country code e.g., +16175551212 (E.164 format).",
"index": 2
}
}
}
}
],
"properties": {
"schema": {
"properties": {
"fromNumber": { "type": "string" }
},
"required": [ "fromNumber" ]
},
"inspector": {
"inputs": {
"fromNumber": {
"type": "select",
"label": "From number",
"tooltip": "Select Twilio phone number.",
"index": 1,
"source": {
"url": "/component/appmixer/twilio/sms/ListFromNumbers?outPort=numbers",
"data": {
"transform": "./transformers#fromNumbersToSelectArray"
}
}
}
}
}
}
},
{
"name": "appmixer.twilio.calls.NewCall",
"author": "David Durman <david@client.io>",
"icon": "data:image/png;base64,iVBORw...gg==",
"description": "Receive a call through Twilio.",
"auth": { "service": "appmixer:twilio" },
"webhook": true,
"webhookAsync": true,
"outPorts": [
{
"name": "call",
"options": []
}
],
"properties": {
"schema": {
"properties": {
"generateInspector": { "type": "boolean" },
"url": {}
}
},
"inspector": {
"inputs": {
"url": {
"source": {
"url": "/component/appmixer/twilio/calls/NewCall?outPort=call",
"data": {
"properties": {
"generateInspector": true
}
}
}
}
}
}
}
}
]

get
Get All Components

https://api.appmixer.com/components
Get all available components. curl "https://api.appmixer.com/components" -H "Authorization: Bearer [ACCESS_TOKEN]"
Request
Response
Request
Query Parameters
manifest
optional
string
If set to "yes", the endpoint returns all components including their manifest files.
Response
200: OK
[
"appmixer.asana.projects.CreateProject",
"appmixer.asana.projects.NewProject",
"appmixer.asana.tasks.CreateStory",
"appmixer.calendly.events.InviteeCanceled",
"appmixer.calendly.events.InviteeCreated",
"appmixer.clearbit.enrichment.FindCompany",
"appmixer.clearbit.enrichment.FindPerson"
]

post
Publish A Component/Module/Service

https://api.appmixer.com/components
Publish a new component, new module or an entire service or update an existing component/module/service. The uploaded entity must be zipped and must have a proper directory/file structure inside (See Basic Component Structure for more details). Note that you can use the Appmixer CLI tool to pack your component/service/module to a zip archive (appmixer pack command). Alternatively, you can also use a regular zip command line utility but you should omit the node_modules/ directories before archiving and the root directory of the zip archive must match the vendor name. The directory hierarchy must have a well defined structure: [vendor]/[service]/[module]/[component]. The size limit of the zip archive is 10MB. Publishing a new component can take more time than a lifespan of a single HTTP request. Therefore, the result of the publishing HTTP call is a JSON object with ticket property. You can use the ticket to check for progress of the publish using the /components/uploader/:ticket endpoint. curl -XPOST "https://api.appmixer.com/components" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-type: application/octet-stream" --data-binary @appmixer.myservice.zip
Request
Response
Request
Response
200: OK
{
"ticket":"a194d145-3768-4a8a-84a4-4f1e4e08c4ad"
}

get
Check for Publishing Progress

https://api.appmixer.com/components/uploader/:ticket
Check for progress of publishing a component. curl -XGET "https://api.appmixer.com/components/uploader/2e9dd726-2b7f-46f7-bea4-8db7f7175aa8" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-type: application/json"
Request
Response
Request
Path Parameters
ticket
required
string
Ticket that you got from the POST /component request.
Response
200: OK
// Successful upload. No errors:
{
"finished": "2020-02-28T15:57:34.549Z"
}
// Upload finished. Errors encountered:
{
"finished": "2020-02-28T15:25:39.515Z",
"err": "Invalid schema for appmixer/utils/service.json",
"data": [
{
"keyword": "required",
"dataPath": "",
"schemaPath": "#/required",
"params": {
"missingProperty": "label"
},
"message": "should have required property 'label'"
},
{
"keyword": "required",
"dataPath": "",
"schemaPath": "#/required",
"params": {
"missingProperty": "description"
},
"message": "should have required property 'description'"
}
]
}

delete
Delete a Component/Module/Service

https://api.appmixer.com/components/:selector
Delete a component/module or an entire service. curl -XDELETE "https://api.appmixer.com/components/appmixer.myservice" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-type: application/json"
Request
Response
Request
Path Parameters
selector
required
string
A selector that uniquely identifies the service/module/component to delete. The selector is of the form [vendor].[service].[module].[component]. For example "appmixer.google.calendar.CreateEvent" (removes just one component) or "appmixer.google.calendar" (removes the calendar module) or "appmixer.google" (removes the entire Google service including all modules and components).
Response
200: OK