API Mappings
Congratulations! You're ready to start using your Processes and let magic happen. But how can they work with your business? This is where API Mappings come in.
You can think of API Mappings as how your Processes interface with the world. It's how Unmeshed allows external entities to trigger and monitor Processes. Technically, is it done by creating uniquely named API endpoints to control the various Processes you've created.
Trigger modes
Process endpoints published via API Mappings can be triggered in three different modes:
| Mode | Description |
|---|---|
| Async | The Process is started and the API call returns immediately with RUNNING status. This is useful for when you're expecting the Process to take a long time and are not interested in waiting for its completion. |
| Streaming | This API call is similar to async, except it keeps the connection open and streams completed steps as they're completed. This can be useful for debugging or when you'd like to follow execution on a step-by-step basis. |
| Synchronously | Starts the Process and does not return a response until the Process is completed. Useful in relatively short Processes or when the client requires to perform synchronous processing. |
Video Overview: Unmeshed API Mappings
Authentication
Unmeshed supports two methods of authentication. Depending on your use-case and integration scenarios, you may need to leverage both!
| Auth Method | Description |
|---|---|
| Configured Auth Mechanisms | API Mappings are intended to be exposed to the outside world. You can configure and use any number of authentication mechanisms for these calls. They don't have to intersect with the authentication mechanism used in Unmeshed itself. |
| Webhook | Allows the creation of webhook URLs with unique embedded tokens in them, restricting usage to only those who have the direct URL. |
Authentication Scenarios
Unmeshed supports OIDC based auth servers. Support for SAML is coming soon. We also offer a built-in user password auth if you prefer to use that.
Once a user is authenticated, the corresponding claims from the user token is set to the process context which can be referred anywhere in the workflow.
Rate limiting
Rate limiting is a feature that is being built - if you need this soon, let us know and we accelerate this build.