{"__v":40,"_id":"5588b8a3f6c18d0d005bba09","category":{"__v":0,"_id":"57f55187440418170086325a","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T19:16:23.805Z","from_sync":false,"order":1,"slug":"integrations","title":"Integration API"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","version":{"__v":14,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["582f855b8ea0800f003563a4"],"next":{"pages":[],"description":""},"createdAt":"2015-06-23T01:38:43.980Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Mixmax integrations are separate from the REST API - they are a way of adding interactivity within emails. For example, you can send a survey, interactive slideshow, or propose meeting times - all from within your email.\n\nThis guide walks you through building \"Hello World\" examples of building on each of the integrations types, using our favorite GIF service, Giphy.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Types of integrations\"\n}\n[/block]\nMixmax offers three ways to integrate your application with the Mixmax compose window.\n\n* [** Enhancements**](doc:overview-enhancement) - Show up as icons in the Mixmax Enhance menu. Examples include Availability, SMS, and Poll. These have a picker UI that pops up in a new window and allows the user to configure them and insert content into the email.\n\n* [**Slash Commands**](doc:overview-slash-commands) - These integrations are accessed using the Mixmax command menu (typing “/” on a new line). Examples include Google Search and Giphy search. The user can pick from a list of search results streamed back as they type, then select one to insert content into the email.\n\n* [**Link Resolvers**](doc:overview-link-resolvers) - When a user pastes a URL on a new line in the editor, Mixmax looks for a Link Resolver to convert the URL into a rich preview. Examples include LinkedIn and Instagram link previews that convert URLs into [rich previews](https://mixmax.com/blog/feature-spotlight-social-media-link-previews) of the destination content.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting started\"\n}\n[/block]\nIntegrations are added to Mixmax from the [Mixmax Dashboard](https://app.mixmax.com/dashboard) -> Integrations page. However, you might want to start by reading through the three \"Tutorial\" sections, one for each integration type, to get you up and running with a working app. See the links in the previous section.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Requirement\"\n}\n[/block]\nAs a developer you're required to host your Mixmax integration on your own server using https. Mixmax will call RESTful APIs endpoints that you expose publicly.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Releasing\"\n}\n[/block]\nWhen you're ready to release your integration to others - whether publicly to all Mixmax users or privately with others at just your company - just email us at support:::at:::mixmax.com with your request.","excerpt":"Learn how to build Mixmax Integrations","slug":"getting-started","type":"basic","title":"Introduction: Integration API"}

Introduction: Integration API

Learn how to build Mixmax Integrations

Mixmax integrations are separate from the REST API - they are a way of adding interactivity within emails. For example, you can send a survey, interactive slideshow, or propose meeting times - all from within your email. This guide walks you through building "Hello World" examples of building on each of the integrations types, using our favorite GIF service, Giphy. [block:api-header] { "type": "basic", "title": "Types of integrations" } [/block] Mixmax offers three ways to integrate your application with the Mixmax compose window. * [** Enhancements**](doc:overview-enhancement) - Show up as icons in the Mixmax Enhance menu. Examples include Availability, SMS, and Poll. These have a picker UI that pops up in a new window and allows the user to configure them and insert content into the email. * [**Slash Commands**](doc:overview-slash-commands) - These integrations are accessed using the Mixmax command menu (typing “/” on a new line). Examples include Google Search and Giphy search. The user can pick from a list of search results streamed back as they type, then select one to insert content into the email. * [**Link Resolvers**](doc:overview-link-resolvers) - When a user pastes a URL on a new line in the editor, Mixmax looks for a Link Resolver to convert the URL into a rich preview. Examples include LinkedIn and Instagram link previews that convert URLs into [rich previews](https://mixmax.com/blog/feature-spotlight-social-media-link-previews) of the destination content. [block:api-header] { "type": "basic", "title": "Getting started" } [/block] Integrations are added to Mixmax from the [Mixmax Dashboard](https://app.mixmax.com/dashboard) -> Integrations page. However, you might want to start by reading through the three "Tutorial" sections, one for each integration type, to get you up and running with a working app. See the links in the previous section. [block:api-header] { "type": "basic", "title": "Requirement" } [/block] As a developer you're required to host your Mixmax integration on your own server using https. Mixmax will call RESTful APIs endpoints that you expose publicly. [block:api-header] { "type": "basic", "title": "Releasing" } [/block] When you're ready to release your integration to others - whether publicly to all Mixmax users or privately with others at just your company - just email us at support@mixmax.com with your request.