Source: https://joinfinn.com/integrations/postman

# Postman

## Postman + Finn.

Postman integration with Finn. Postman helps teams design, document, test, and collaborate on APIs.

Business function: Engineering and data.

## What you can do with Postman.

Postman helps teams design, document, test, and collaborate on APIs.

### Build and run a complete API regression suite

Finn turns the team's important API journeys into executable tests and resolves the failures those tests uncover.

**Typically handled by:** API quality assurance engineer

**Starts when:** An API release needs repeatable checks for its accepted customer journeys.

#### What Finn handles

1. Read the API contract and build the Postman requests, test data, and assertions for the selected journeys.
2. Run the collection against the designated test environment and inspect the failed requests and responses.
3. Fix application defects through connected GitHub or correct inaccurate tests, with the required code review.
4. Run the complete affected collection again and attach its result to the release issue in Jira.

**The result:** The release has repeatable API coverage and a result after the discovered defects are addressed.

### Diagnose and repair a broken integration

Finn reproduces an integration failure with the request shape, corrects its cause, and verifies the connected workflow.

**Typically handled by:** Integration engineer

**Starts when:** A partner or internal system reports failed API requests.

#### What Finn handles

1. Collect the endpoint, request details, and error from the support case, keeping credentials out of the shared collection.
2. Reproduce the failure in Postman with a test account and compare the behavior with the API contract.
3. Implement the application or request-mapping correction through GitHub and follow its review and release process.
4. Rerun the integration journey and send the verified resolution through the connected support system.

**The result:** The integration works for the tested scenario and the case links to the request, repair, and test result.

### Give a partner working API examples

Finn creates a usable collection that lets a partner complete the integration's first real test journey.

**Typically handled by:** Developer relations engineer

**Starts when:** A partner is ready to implement an agreed API integration.

#### What Finn handles

1. Read the partner's use case and select the endpoints, input fields, and test environment it needs.
2. Build the Postman collection with clear instructions, example responses, and variables that exclude private credentials.
3. Run the collection using designated test access and correct any failing or unclear steps.
4. Share the collection through the accepted workspace or document channel and answer implementation questions using its tested requests.

**The result:** The partner receives an executable, documented integration example with a recorded successful test.

### Keep API documentation aligned with behavior

Finn updates the collection's descriptions and examples when the API changes, then proves that the instructions still work.

**Typically handled by:** API technical writer

**Starts when:** A reviewed API change alters request fields, responses, or a customer journey.

#### What Finn handles

1. Compare the change with the existing Postman collection and its documented examples.
2. Update the requests, descriptions, and response examples to match the new contract.
3. Run the examples in the test environment and resolve inconsistencies with the API owner.
4. Save the finished collection and notify its users through connected Slack or email, linking the change and test result.

**The result:** The shared API instructions match the released contract and contain examples that have been tested.

### Provide a mock API for a blocked team

Finn builds a realistic mock of an agreed API contract so another team can finish its work before the service is available.

**Typically handled by:** Integration enablement engineer

**Starts when:** A client development team is blocked waiting for an API endpoint.

#### What Finn handles

1. Read the accepted contract and select the success and error scenarios the client must handle.
2. Create a Postman collection with representative example responses and a private mock server.
3. Run the client's expected requests against the mock and correct mismatches in the examples.
4. Share the endpoint and usage instructions with the named team and link them to the development issue.

**The result:** The client team has a working test endpoint and clearly documented simulated behavior.

### Resolve an API monitor failure

Finn investigates a failed scheduled API check and follows the repair through a successful run.

**Typically handled by:** API operations engineer

**Starts when:** A Postman monitor reports a failed request or assertion.

#### What Finn handles

1. Read the monitor result, request details, and recent release changes to locate the failure.
2. Distinguish an application problem from expired test access or an outdated expected response.
3. Repair the owning code or test configuration through its normal change process and required review.
4. Run the monitor again, confirm the affected journey succeeds, and update the incident or support case.

**The result:** The monitor's failed journey has a verified resolution and the case records what changed.

### Add API checks to the release pipeline

Finn connects the team's Postman collection to its existing build workflow so release readiness includes the agreed API tests.

**Typically handled by:** Build and release engineer

**Starts when:** The team accepts API regression checks as a requirement for an existing release workflow.

#### What Finn handles

1. Select the collection and test environment that represent the release's required API behavior.
2. Update the connected GitHub Actions workflow to run the collection through the Postman CLI and retain its results.
3. Run the workflow on a development change, resolve failures, and submit the workflow update for review.
4. Merge the accepted change and confirm the release workflow records the API test result on its next run.

**The result:** The release pipeline runs the agreed API checks and exposes their results to the release decision.

## Connection setup

Contact Finn to discuss the records your workflow needs and the actions you want it to perform.

Your team chooses what Finn can access, what agents can change, and when a person must approve the work. The connection needs the appropriate account access and permissions from Postman.

[Visit Postman](https://www.postman.com/)

## Explore Finn

- [Agents](https://joinfinn.com/agents): Help customers. Work with your team. Finish the job.
- [Systems](https://joinfinn.com/systems): Business apps for the work behind the conversation.
- [AI Gateway](https://joinfinn.com/ai-gateway): Control connected AI apps, models, access, and spending.

[All integrations](https://joinfinn.com/integrations)

[Discuss this integration](https://joinfinn.com/contact)

[Discuss your workflow](https://joinfinn.com/contact) · [How it works](https://joinfinn.com/demo/app/#/w/borough/overview) · [Get started](https://joinfinn.com/app/#/signup)