Extend the capability of the *Welcome* Platform using our open API. Integrate your way with any system in your MarTech stack.
About Custom API
Create something that works for you! Explore how you can harness the power of the Welcome platform by using our public API. Maybe you have applications in your Martech stack that are working for you today and you'd just like to send Welcome data to help you work even more efficiently. Or, maybe your teams need more automation, more reporting, and more everything! At Welcome, we understand that sometimes the best solution is to give a builder a whole toolbox so they can build their dream house. That's why our open API is designed to adapt to your needs as it extends the functionality you see in the platform into the hands of your developers so that they can create the best experience for you and your stakeholders.
Why Developers 💜 Welcome's Public API
Welcome's public API is fully documented at developers.welcomesoftware.com. What you'll find with our API that is industry standard is that it is REST-based, JSON formatted, OAuth 2.0 compliant, and is fully supported with self-service client registration in the Welcome Platform. (You can also find the documentation to register your client in our knowledgebase here. What is unique about Welcome's open API is:
Provides several opportunities for in-app communication (ex. Comments and Error messages can be 'pushed' to the user interface)
Comes with compatible webhooks which help integrators maintain a near real-time bi-directional data flow from beginning to end
- Clear, concise, generic and reusable data models which can be shared between your other applications (ex. Images vs Articles)
Custom API features
Features - How Does it Work?
- Register an API Client Application
Your team will build an API client application which will authenticate to Welcome on behalf of users. You'll obtain authentication tokens and establish a secure, reliable connection through this registration process.
- Connect to Welcome webhooks and 'listen' for key events
Key 'events' in Welcome trigger webhooks to call your API client application. For example - when an asset is published to the library, the webhook for 'asset_added' is triggered. Once your application is registered with Welcome, we forward the event to your client so it can be processed.
- That's it!
Once your app is registered and listening for events, it can 'talk' to Welcome through these events. Now, it's up to your app to do all the things you need it to do.
And that is how you connect to Welcome to build any type of integration you can imagine. Connect your favorite apps, save time and money, and build what you need to suit your team and your customers.
Custom API pricing
Access to our Open API is free with your Welcome license. Access to all the API documentation is free however at developers.welcomesoftware.com. Use the Contact Us button if you need any assistance in getting your apps connected today!