Importing Custom Capabilities via Postman Collection

When integrating your API with Interworky via a Postman Collection, it’s important to follow these guidelines to ensure a smooth import process

Importing Custom Capabilities via Postman Collection

Exporting Your Postman Collection

• File Format:

  • Make sure your Postman Collection is exported as a JSON file.

• Version:

  • Export your collection as v2.1. This is the supported version for Interworky imports.

Configuring Environment Variables

Your Postman Collection may include dynamic values, such as the host URL for different environments (e.g., development, staging, production).

Adding your POSTMAN host/base_url environment variable

To handle this Use Variables:

Instead of hardcoding the host URL in your API endpoints, use a variable. For example, For your host you might use: {{baseURL}}

• Defining the Variable:

In your Postman environment or collection, define:

• Variable Name: baseURL

• Variable Value: The corresponding URL for your desired environment (e.g., https://dev.interworky.com or https://productionserver.mywebsite.com).

Local environments might not work properly with this configuration. Ensure you use a URL that’s accessible from the internet, such as your staging or production domain